diff --git a/package-lock.json b/package-lock.json index 5c7f40618..6dc3bf7cf 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,56 +12,48 @@ "@octokit/core": "^6.0.0", "@octokit/plugin-paginate-rest": "^11.0.0", "github-enterprise-server-versions": "^2.0.0", - "openapi-typescript": "^6.2.1", + "openapi-typescript": "^7.0.0", "prettier": "3.3.2" } }, - "node_modules/@fastify/busboy": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", - "integrity": "sha512-vBZP4NlzfOlerQTnba4aqZoMhE/a9HY7HRqoOPaETQcSQuWEIyZMHGfVu6w9wGtGK5fED5qRs2DteVCjOH60sA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=14" - } - }, - "node_modules/@nodelib/fs.scandir": { - "version": "2.1.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", - "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "node_modules/@babel/code-frame": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz", + "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==", "dev": true, "license": "MIT", "dependencies": { - "@nodelib/fs.stat": "2.0.5", - "run-parallel": "^1.1.9" + "@babel/highlight": "^7.24.7", + "picocolors": "^1.0.0" }, "engines": { - "node": ">= 8" + "node": ">=6.9.0" } }, - "node_modules/@nodelib/fs.stat": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", - "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "node_modules/@babel/helper-validator-identifier": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz", + "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==", "dev": true, "license": "MIT", "engines": { - "node": ">= 8" + "node": ">=6.9.0" } }, - "node_modules/@nodelib/fs.walk": { - "version": "1.2.8", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", - "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "node_modules/@babel/highlight": { + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz", + "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==", "dev": true, "license": "MIT", "dependencies": { - "@nodelib/fs.scandir": "2.1.5", - "fastq": "^1.6.0" + "@babel/helper-validator-identifier": "^7.24.7", + "chalk": "^2.4.2", + "js-tokens": "^4.0.0", + "picocolors": "^1.0.0" }, "engines": { - "node": ">= 8" + "node": ">=6.9.0" } }, "node_modules/@octokit/auth-token": { @@ -184,6 +176,67 @@ "@octokit/openapi-types": "^22.2.0" } }, + "node_modules/@redocly/ajv": { + "version": "8.11.0", + "resolved": "https://registry.npmjs.org/@redocly/ajv/-/ajv-8.11.0.tgz", + "integrity": "sha512-9GWx27t7xWhDIR02PA18nzBdLcKQRgc46xNQvjFkrYk4UOmvKhJ/dawwiX0cCOeetN5LcaaiqQbVOWYK62SGHw==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@redocly/config": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/@redocly/config/-/config-0.6.0.tgz", + "integrity": "sha512-hNVN3eTxFj2nHYX0gGzZxxXwdE0DXWeWou1TIK3HYf0S9VKVxTxjO9EZbMB7iVUqaHkeqy4PSjlBQcEgD0Ftjg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@redocly/openapi-core": { + "version": "1.16.0", + "resolved": "https://registry.npmjs.org/@redocly/openapi-core/-/openapi-core-1.16.0.tgz", + "integrity": "sha512-z06h+svyqbUcdAaePq8LPSwTPlm6Ig7j2VlL8skPBYnJvyaQ2IN7x/JkOvRL4ta+wcOCBdAex5JWnZbKaNktJg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@redocly/ajv": "^8.11.0", + "@redocly/config": "^0.6.0", + "colorette": "^1.2.0", + "https-proxy-agent": "^7.0.4", + "js-levenshtein": "^1.1.6", + "js-yaml": "^4.1.0", + "lodash.isequal": "^4.5.0", + "minimatch": "^5.0.1", + "node-fetch": "^2.6.1", + "pluralize": "^8.0.0", + "yaml-ast-parser": "0.0.43" + }, + "engines": { + "node": ">=14.19.0", + "npm": ">=7.0.0" + } + }, + "node_modules/agent-base": { + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/agent-base/-/agent-base-7.1.1.tgz", + "integrity": "sha512-H0TSyFNDMomMNJQBn8wFV5YC/2eJ+VXECwOadZJT554xP6cODZHPX3H9QMQECxvrgiSOP1pHjy1sMWQVYJOUOA==", + "dev": true, + "license": "MIT", + "dependencies": { + "debug": "^4.3.4" + }, + "engines": { + "node": ">= 14" + } + }, "node_modules/ansi-colors": { "version": "4.1.3", "resolved": "https://registry.npmjs.org/ansi-colors/-/ansi-colors-4.1.3.tgz", @@ -194,6 +247,19 @@ "node": ">=6" } }, + "node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", @@ -201,6 +267,13 @@ "dev": true, "license": "Python-2.0" }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true, + "license": "MIT" + }, "node_modules/before-after-hook": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-3.0.2.tgz", @@ -208,59 +281,103 @@ "dev": true, "license": "Apache-2.0" }, - "node_modules/braces": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.3.tgz", - "integrity": "sha512-yQbXgO/OSZVD2IsiLlro+7Hf6Q18EJrKSEsdoMzKePKXct3gvD8oLcOQdIzGupr5Fj+EDe8gO/lxc1BzfMpxvA==", + "node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", "dev": true, "license": "MIT", "dependencies": { - "fill-range": "^7.1.1" + "balanced-match": "^1.0.0" + } + }, + "node_modules/chalk": { + "version": "2.4.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", + "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^3.2.1", + "escape-string-regexp": "^1.0.5", + "supports-color": "^5.3.0" }, "engines": { - "node": ">=8" + "node": ">=4" } }, - "node_modules/fast-glob": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", - "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", + "node_modules/chalk/node_modules/supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", "dev": true, "license": "MIT", "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.2", - "merge2": "^1.3.0", - "micromatch": "^4.0.4" + "has-flag": "^3.0.0" }, "engines": { - "node": ">=8.6.0" + "node": ">=4" } }, - "node_modules/fastq": { - "version": "1.17.1", - "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.17.1.tgz", - "integrity": "sha512-sRVD3lWVIXWg6By68ZN7vho9a1pQcN/WBFaAAsDDFzlJjvoGx0P8z7V1t72grFJfJhu3YPZBuu25f7Kaw2jN1w==", + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", "dev": true, - "license": "ISC", + "license": "MIT", "dependencies": { - "reusify": "^1.0.4" + "color-name": "1.1.3" } }, - "node_modules/fill-range": { - "version": "7.1.1", - "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.1.1.tgz", - "integrity": "sha512-YsGpe3WHLK8ZYi4tWDg2Jy3ebRz2rXowDxnld4bkQB00cc/1Zw9AWnC0i9ztDJitivtQvaI9KaLyKrc+hBW0yg==", + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "dev": true, + "license": "MIT" + }, + "node_modules/colorette": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colorette/-/colorette-1.4.0.tgz", + "integrity": "sha512-Y2oEozpomLn7Q3HFP7dpww7AtMJplbM9lGZP6RDfHqmbeRjiwRg4n6VM6j4KLmRke85uWEI7JqF17f3pqdRA0g==", + "dev": true, + "license": "MIT" + }, + "node_modules/debug": { + "version": "4.3.5", + "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.5.tgz", + "integrity": "sha512-pt0bNEmneDIvdL1Xsd9oDQ/wrQRkXDT4AUWlNZNPKvW5x/jyO9VFXkJUP07vQ2upmw5PlaITaPKc31jK13V+jg==", "dev": true, "license": "MIT", "dependencies": { - "to-regex-range": "^5.0.1" + "ms": "2.1.2" }, "engines": { - "node": ">=8" + "node": ">=6.0" + }, + "peerDependenciesMeta": { + "supports-color": { + "optional": true + } + } + }, + "node_modules/escape-string-regexp": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", + "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.0" } }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true, + "license": "MIT" + }, "node_modules/github-enterprise-server-versions": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/github-enterprise-server-versions/-/github-enterprise-server-versions-2.0.1.tgz", @@ -271,52 +388,60 @@ "node-fetch": "^2.6.1" } }, - "node_modules/glob-parent": { - "version": "5.1.2", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", - "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "node_modules/has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", "dev": true, - "license": "ISC", - "dependencies": { - "is-glob": "^4.0.1" - }, + "license": "MIT", "engines": { - "node": ">= 6" + "node": ">=4" } }, - "node_modules/is-extglob": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", - "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "node_modules/https-proxy-agent": { + "version": "7.0.4", + "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.4.tgz", + "integrity": "sha512-wlwpilI7YdjSkWaQ/7omYBMTliDcmCN8OLihO6I9B86g06lMyAoqgoDpV0XqoaPOKj+0DIdAvnsWfyAAhmimcg==", "dev": true, "license": "MIT", + "dependencies": { + "agent-base": "^7.0.2", + "debug": "4" + }, "engines": { - "node": ">=0.10.0" + "node": ">= 14" } }, - "node_modules/is-glob": { - "version": "4.0.3", - "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", - "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "node_modules/index-to-position": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/index-to-position/-/index-to-position-0.1.2.tgz", + "integrity": "sha512-MWDKS3AS1bGCHLBA2VLImJz42f7bJh8wQsTGCzI3j519/CASStoDONUBVz2I/VID0MpiX3SGSnbOD2xUalbE5g==", "dev": true, "license": "MIT", - "dependencies": { - "is-extglob": "^2.1.1" - }, "engines": { - "node": ">=0.10.0" + "node": ">=18" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/is-number": { - "version": "7.0.0", - "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", - "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "node_modules/js-levenshtein": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/js-levenshtein/-/js-levenshtein-1.1.6.tgz", + "integrity": "sha512-X2BB11YZtrRqY4EnQcLX5Rh373zbK4alC1FW7D7MBhL2gtcC17cTnr6DmfHZeS0s2rTHjUTMMHfG7gO8SSdw+g==", "dev": true, "license": "MIT", "engines": { - "node": ">=0.12.0" + "node": ">=0.10.0" } }, + "node_modules/js-tokens": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true, + "license": "MIT" + }, "node_modules/js-yaml": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", @@ -330,30 +455,40 @@ "js-yaml": "bin/js-yaml.js" } }, - "node_modules/merge2": { - "version": "1.4.1", - "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", - "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", "dev": true, - "license": "MIT", - "engines": { - "node": ">= 8" - } + "license": "MIT" }, - "node_modules/micromatch": { - "version": "4.0.7", - "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.7.tgz", - "integrity": "sha512-LPP/3KorzCwBxfeUuZmaR6bG2kdeHSbe0P2tY3FLRU4vYrjYz5hI4QZwV0njUx3jeuKe67YukQ1LSPZBKDqO/Q==", + "node_modules/lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", "dev": true, - "license": "MIT", + "license": "MIT" + }, + "node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "license": "ISC", "dependencies": { - "braces": "^3.0.3", - "picomatch": "^2.3.1" + "brace-expansion": "^2.0.1" }, "engines": { - "node": ">=8.6" + "node": ">=10" } }, + "node_modules/ms": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", + "integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==", + "dev": true, + "license": "MIT" + }, "node_modules/node-fetch": { "version": "2.7.0", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz", @@ -376,34 +511,58 @@ } }, "node_modules/openapi-typescript": { - "version": "6.7.6", - "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-6.7.6.tgz", - "integrity": "sha512-c/hfooPx+RBIOPM09GSxABOZhYPblDoyaGhqBkD/59vtpN21jEuWKDlM0KYTvqJVlSYjKs0tBcIdeXKChlSPtw==", + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/openapi-typescript/-/openapi-typescript-7.0.0.tgz", + "integrity": "sha512-5NobO3pavTUVmErRVjnfiIIqCNjCrZeva4ElOA3nNKcSo4Jm5G7zv4WLcw6S+jDVnGGRkchxnJ2yIJBp9ULUAg==", "dev": true, "license": "MIT", "dependencies": { + "@redocly/openapi-core": "^1.16.0", "ansi-colors": "^4.1.3", - "fast-glob": "^3.3.2", - "js-yaml": "^4.1.0", + "parse-json": "^8.1.0", "supports-color": "^9.4.0", - "undici": "^5.28.4", "yargs-parser": "^21.1.1" }, "bin": { "openapi-typescript": "bin/cli.js" + }, + "peerDependencies": { + "typescript": "^5.x" } }, - "node_modules/picomatch": { - "version": "2.3.1", - "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", - "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "node_modules/parse-json": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/parse-json/-/parse-json-8.1.0.tgz", + "integrity": "sha512-rum1bPifK5SSar35Z6EKZuYPJx85pkNaFrxBK3mwdfSJ1/WKbYrjoW/zTPSjRRamfmVX1ACBIdFAO0VRErW/EA==", "dev": true, "license": "MIT", + "dependencies": { + "@babel/code-frame": "^7.22.13", + "index-to-position": "^0.1.2", + "type-fest": "^4.7.1" + }, "engines": { - "node": ">=8.6" + "node": ">=18" }, "funding": { - "url": "https://github.com/sponsors/jonschlinkert" + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/picocolors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.1.tgz", + "integrity": "sha512-anP1Z8qwhkbmu7MFP5iTt+wQKXgwzf7zTyGlcdzabySa9vd0Xt392U0rVmz9poOaBj0uHJKyyo9/upk0HrEQew==", + "dev": true, + "license": "ISC" + }, + "node_modules/pluralize": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/pluralize/-/pluralize-8.0.0.tgz", + "integrity": "sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=4" } }, "node_modules/prettier": { @@ -422,60 +581,24 @@ "url": "https://github.com/prettier/prettier?sponsor=1" } }, - "node_modules/queue-microtask": { - "version": "1.2.3", - "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", - "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT" - }, - "node_modules/reusify": { - "version": "1.0.4", - "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", - "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "node_modules/punycode": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", + "integrity": "sha512-vYt7UD1U9Wg6138shLtLOvdAu+8DsC/ilFtEVHcH+wydcSpNE20AfSOduf6MkRFahL5FY7X1oU7nKVZFtfq8Fg==", "dev": true, "license": "MIT", "engines": { - "iojs": ">=1.0.0", - "node": ">=0.10.0" + "node": ">=6" } }, - "node_modules/run-parallel": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", - "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, "license": "MIT", - "dependencies": { - "queue-microtask": "^1.2.2" + "engines": { + "node": ">=0.10.0" } }, "node_modules/supports-color": { @@ -491,19 +614,6 @@ "url": "https://github.com/chalk/supports-color?sponsor=1" } }, - "node_modules/to-regex-range": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", - "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "is-number": "^7.0.0" - }, - "engines": { - "node": ">=8.0" - } - }, "node_modules/tr46": { "version": "0.0.3", "resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz", @@ -511,17 +621,32 @@ "dev": true, "license": "MIT" }, - "node_modules/undici": { - "version": "5.28.4", - "resolved": "https://registry.npmjs.org/undici/-/undici-5.28.4.tgz", - "integrity": "sha512-72RFADWFqKmUb2hmmvNODKL3p9hcB6Gt2DOQMis1SEBaV6a4MH8soBvzg+95CYhCKPFedut2JY9bMfrDl9D23g==", + "node_modules/type-fest": { + "version": "4.20.1", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.20.1.tgz", + "integrity": "sha512-R6wDsVsoS9xYOpy8vgeBlqpdOyzJ12HNfQhC/aAKWM3YoCV9TtunJzh/QpkMgeDhkoynDcw5f1y+qF9yc/HHyg==", "dev": true, - "license": "MIT", - "dependencies": { - "@fastify/busboy": "^2.0.0" + "license": "(MIT OR CC0-1.0)", + "engines": { + "node": ">=16" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/typescript": { + "version": "5.4.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz", + "integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==", + "dev": true, + "license": "Apache-2.0", + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" }, "engines": { - "node": ">=14.0" + "node": ">=14.17" } }, "node_modules/universal-user-agent": { @@ -531,6 +656,16 @@ "dev": true, "license": "ISC" }, + "node_modules/uri-js": { + "version": "4.4.1", + "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", + "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "punycode": "^2.1.0" + } + }, "node_modules/webidl-conversions": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz", @@ -549,6 +684,13 @@ "webidl-conversions": "^3.0.0" } }, + "node_modules/yaml-ast-parser": { + "version": "0.0.43", + "resolved": "https://registry.npmjs.org/yaml-ast-parser/-/yaml-ast-parser-0.0.43.tgz", + "integrity": "sha512-2PTINUwsRqSd+s8XxKaJWQlUuEMHJQyEuh2edBbW8KNJz0SJPwUSD2zRWqezFEdN7IzAgeuYHFUCF7o8zRdZ0A==", + "dev": true, + "license": "Apache-2.0" + }, "node_modules/yargs-parser": { "version": "21.1.1", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", diff --git a/package.json b/package.json index 710a4fae0..5ea6ea0bc 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "@octokit/core": "^6.0.0", "@octokit/plugin-paginate-rest": "^11.0.0", "github-enterprise-server-versions": "^2.0.0", - "openapi-typescript": "^6.2.1", + "openapi-typescript": "^7.0.0", "prettier": "3.3.2" }, "prettier": {}, diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index 96be55a38..64b40973d 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -3,172 +3,361 @@ * Do not make direct changes to the file. */ -/** OneOf type helpers */ -type Without = { [P in Exclude]?: never }; -type XOR = T | U extends object - ? (Without & U) | (Without & T) - : T | U; -type OneOf = T extends [infer Only] - ? Only - : T extends [infer A, infer B, ...infer Rest] - ? OneOf<[XOR, ...Rest]> - : never; - export interface paths { "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List global security advisories * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." */ get: operations["security-advisories/list-global-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a global security advisory * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. */ get: operations["security-advisories/get-global-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated app * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installations for the authenticated app * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * - * The permissions the installation has are included under the `permissions` key. + * The permissions the installation has are included under the `permissions` key. */ get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. + * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. @@ -179,750 +368,1474 @@ export interface paths { * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. */ delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; + trace?: never; }; "/applications/{client_id}/token/scoped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a scoped access token * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. + * which repositories the token can access and which permissions are granted to the + * token. * - * Invalid tokens will return `404 NOT FOUND`. + * Invalid tokens will return `404 NOT FOUND`. * - * You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. + * You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ post: operations["apps/scope-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/assignments/{assignment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an assignment * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ get: operations["classroom/get-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/assignments/{assignment_id}/accepted_assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/assignments/{assignment_id}/grades": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get assignment grades * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ get: operations["classroom/get-assignment-grades"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/classrooms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List classrooms * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. */ get: operations["classroom/list-classrooms"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/classrooms/{classroom_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a classroom * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. */ get: operations["classroom/get-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/classrooms/{classroom_id}/assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignments for a classroom * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. */ get: operations["classroom/list-assignments-for-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get emojis * @description Lists all the emojis available to use on GitHub Enterprise Cloud. */ get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise-installation/{enterprise_or_org}/server-statistics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Enterprise Server statistics * @description 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. + * 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. * - * OAuth app tokens and personal access tokens (classic) need: - * - the `read:enterprise` scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics - * - the `read:org` scope if you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics + * OAuth app tokens and personal access tokens (classic) need: + * - the `read:enterprise` scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics + * - the `read:org` scope if you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics */ get: operations["enterprise-admin/get-server-statistics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an enterprise * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/oidc/customization/issuer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Set the GitHub Actions OIDC custom issuer policy for an enterprise * @description Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["actions/set-actions-oidc-custom-issuer-policy-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an enterprise * @description Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; /** * Set GitHub Actions permissions for an enterprise * @description Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; /** * Set selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected organization for GitHub Actions in an enterprise * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + post?: never; /** * Disable a selected organization for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions and reusable workflows for an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-allowed-actions-enterprise"]; /** * Set allowed actions and reusable workflows for an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-allowed-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an enterprise * @description 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)." + * 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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-enterprise"]; /** * Set default workflow permissions for an enterprise * @description 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)." + * 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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an enterprise * @description Lists all self-hosted runner groups for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + put?: never; /** * Create a self-hosted runner group for an enterprise * @description Creates a new self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an enterprise * @description Gets a specific self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an enterprise * @description Deletes a self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an enterprise * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization access to a self-hosted runner group in an enterprise * @description Lists the organizations with access to a self-hosted runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Set organization access for a self-hosted runner group in an enterprise * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add organization access to a self-hosted runner group in an enterprise * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; /** * Remove organization access to a self-hosted runner group in an enterprise * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an enterprise * @description Lists the self-hosted runners that are in a specific enterprise group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Set self-hosted runners in a group for an enterprise * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an enterprise * @description Adds a self-hosted runner to a runner group configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + post?: never; /** * Remove a self-hosted runner from a group for an enterprise * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an enterprise * @description Lists all self-hosted runners configured for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an enterprise * @description Lists binaries for the runner application that you can download and run. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an Enterprise * @description Generates a configuration that can be passed to the runner application at startup. * - * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an enterprise * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * Example using registration token: + * Example using registration token: * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-registration-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an enterprise * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * Example using remove token: + * Example using remove token: * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-remove-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an enterprise * @description Gets a specific self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an enterprise * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an enterprise * @description Lists all labels for a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; /** * Set custom labels for a self-hosted runner for an enterprise * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. + * self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; /** * Add custom labels to a self-hosted runner for an enterprise * @description Add custom labels to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; /** * Remove all custom labels from a self-hosted runner for an enterprise * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. + * enterprise. Returns the remaining read-only labels from the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an enterprise * @description Remove a custom label from a self-hosted runner configured - * in an enterprise. Returns the remaining labels from the runner. + * 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get announcement banner for enterprise * @description Gets the announcement banner currently set for the enterprise. */ get: operations["announcement-banners/get-announcement-banner-for-enterprise"]; + put?: never; + post?: never; /** * Remove announcement banner from enterprise * @description Removes the announcement banner currently set for the enterprise. */ delete: operations["announcement-banners/remove-announcement-banner-for-enterprise"]; + options?: never; + head?: never; /** * Set announcement banner for enterprise * @description Sets the announcement banner to display for the enterprise. */ patch: operations["announcement-banners/set-announcement-banner-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an enterprise * @description Gets the audit log for an enterprise. * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." * - * The authenticated user must be an enterprise admin to use this endpoint. + * The authenticated user must be an enterprise admin to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. */ get: operations["enterprise-admin/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an enterprise * @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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. */ get: operations["code-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code_security_and_analysis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get code security and analysis features for an enterprise * @description Gets code security and analysis settings for the specified enterprise. * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["secret-scanning/get-security-analysis-settings-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update code security and analysis features for an enterprise * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ patch: operations["secret-scanning/patch-security-analysis-settings-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/consumed-licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List enterprise consumed licenses * @description Lists the license consumption information for all users, including those from connected servers, associated with an enterprise. * - * The authenticated user must be an enterprise admin to use this endpoint. + * The authenticated user must be an enterprise admin to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-consumed-licenses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a summary of Copilot usage for enterprise members * @description **Note**: This endpoint is in beta and is subject to change. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, + * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + * metrics for the enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. */ get: operations["copilot/usage-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ get: operations["dependabot/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/license-sync-status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a license sync status * @description Gets information about the status of a license sync job for an enterprise. * - * The authenticated user must be an enterprise admin to use this endpoint. + * The authenticated user must be an enterprise admin to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-license-sync-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an enterprise * @description 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. + * 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. */ get: operations["secret-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/settings/billing/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions billing for an enterprise * @description Gets the summary of the free and paid GitHub Actions minutes used. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage 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/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage 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/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * The authenticated user must be an enterprise admin. + * The authenticated user must be an enterprise admin. */ get: operations["billing/get-github-actions-billing-ghe"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an enterprise * @description 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-ghe"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/settings/billing/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Packages billing for an enterprise * @description Gets the free and paid storage used for GitHub Packages in gigabytes. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * The authenticated user must be an enterprise admin. + * The authenticated user must be an enterprise admin. */ get: operations["billing/get-github-packages-billing-ghe"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/settings/billing/shared-storage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get shared storage billing for an enterprise * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * The authenticated user must be an enterprise admin. + * The authenticated user must be an enterprise admin. */ get: operations["billing/get-shared-storage-billing-ghe"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature * @description Enables or disables the specified security feature for all repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ post: operations["secret-scanning/post-security-product-enablement-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public events * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ get: operations["activity/list-public-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get feeds * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * - * * **Timeline**: The GitHub Enterprise Cloud global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. + * * **Timeline**: The GitHub Enterprise Cloud global public timeline + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List starred gists * @description List the authenticated user's starred gists: */ get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @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. */ patch: operations["gists/update"]; + trace?: never; }; "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update-comment"]; + trace?: never; }; "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist commits */ get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist forks */ get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a gist is starred */ get: operations["gists/check-is-starred"]; /** @@ -930,173 +1843,418 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; + post?: never; /** Unstar a gist */ delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. */ get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issues assigned to the authenticated user * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Render a Markdown document */ post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a subscription plan for an account * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List plans * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List accounts for a plan * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/stubbed/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a subscription plan for an account (stubbed) * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/stubbed/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List plans (stubbed) * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List accounts for a plan (stubbed) * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Enterprise Cloud meta information * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/)." * - * The API's response also includes a list of GitHub's domain names. + * The API's response also includes a list of GitHub's domain names. * - * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. + * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/networks/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a network of repositories */ get: operations["activity/list-public-events-for-repo-network"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. @@ -1107,197 +2265,331 @@ export interface paths { * @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 Enterprise Cloud 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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + put?: never; + post?: never; /** * Mark a thread as done * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications. */ delete: operations["activity/mark-thread-as-done"]; + options?: never; + head?: never; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Cloud: https://github.com/notifications. */ patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread subscription for the authenticated user * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription). * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Octocat * @description Get the octocat as ASCII art */ get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations/{organization_id}/custom_roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Deprecated - List custom repository roles in an organization * @deprecated * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-roles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/). * - * To see the full details about an organization, the authenticated user must be an organization owner. + * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * - * To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. + * To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. */ get: operations["orgs/get"]; + put?: never; + post?: never; /** * Delete an organization * @description Deletes an organization and all its repositories. * - * The organization login will be unavailable for 90 days after deletion. + * The organization login will be unavailable for 90 days after deletion. * - * Please review the Terms of Service regarding account deletion before using this endpoint: + * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; + options?: never; + head?: never; /** * Update an organization * @description **Parameter Deprecation Notice:** GitHub Enterprise Cloud 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). * - * Updates the organization's profile and member privileges. + * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ patch: operations["orgs/update"]; + trace?: never; }; "/orgs/{org}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an organization * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/cache/usage-by-repository": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["oidc/update-oidc-custom-sub-template-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories enabled for GitHub Actions in an organization * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** @@ -1305,620 +2597,984 @@ export interface paths { * @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)." * * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions and reusable workflows for an organization * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions for an organization * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an organization * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; /** * Create a self-hosted runner group for an organization * @description Creates a new self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an organization * @description Gets a specific self-hosted runner group for an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an organization * @description Deletes a self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an organization * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository access to a self-hosted runner group in an organization * @description Lists the repositories with access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; /** * Set repository access for a self-hosted runner group in an organization * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add repository access to a self-hosted runner group in an organization * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; /** * Remove repository access to a self-hosted runner group in an organization * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an organization * @description Lists self-hosted runners that are in a specific organization group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-in-group-for-org"]; /** * Set self-hosted runners in a group for an organization * @description Replaces the list of self-hosted runners that are part of an organization runner group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an organization * @description Adds a self-hosted runner to a runner group configured in an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; /** * Remove a self-hosted runner from a group for an organization * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the organization. + * The authenticated user must have admin access to the organization. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** * Set custom labels for a self-hosted runner for an organization * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. + * self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization * @description Adds custom labels to a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** * Remove all custom labels from a self-hosted runner for an organization * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. + * organization. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an organization * @description Remove a custom label from a self-hosted runner configured - * in an organization. Returns the remaining labels from the runner. + * in an organization. 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * The authenticated user must have collaborator access to a repository to create, update, or read secrets * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to + * use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. For more information about setting the visibility, see [Create or + * update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization variables * @description Lists all organization variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-variables"]; + put?: never; /** * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-org-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization variable * @description Gets a specific variable in an organization. * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-variable"]; + put?: never; + post?: never; /** * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-variable"]; + options?: never; + head?: never; /** * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ patch: operations["actions/update-org-variable"]; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization variable * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. + * that is available to selected repositories. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-variable"]; /** * Set selected repositories for an organization variable * @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`. + * to selected repositories. Organization variables that are available to selected + * repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-variable"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization variable * @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`. + * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-variable"]; + post?: never; /** * Remove selected repository from an organization variable * @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`. + * available to selected repositories. Organization variables that are available to + * selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-variable"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get announcement banner for organization * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. + * organization level. Organization members may also see an enterprise-level announcement banner. To get an + * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. */ get: operations["announcement-banners/get-announcement-banner-for-org"]; + put?: never; + post?: never; /** * Remove announcement banner from organization * @description Removes the announcement banner currently set for the organization. */ delete: operations["announcement-banners/remove-announcement-banner-for-org"]; + options?: never; + head?: never; /** * Set announcement banner for organization * @description Sets the announcement banner to display for the organization. */ patch: operations["announcement-banners/set-announcement-banner-for-org"]; + trace?: never; }; "/orgs/{org}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an organization * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." + * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. */ get: operations["orgs/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users blocked by an organization * @description List the users blocked by an organization. */ get: operations["orgs/list-blocked-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is blocked by an organization * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. @@ -1929,51 +3585,103 @@ export interface paths { * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. */ put: operations["orgs/block-user"]; + post?: never; /** * Unblock a user from an organization * @description Unblocks the given user on behalf of the specified organization. */ delete: operations["orgs/unblock-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-in-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-codespaces-access"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/access/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add users to Codespaces access for an organization * @deprecated * @description Codespaces for the specified users will be billed to the organization. * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + * To use this endpoint, the access settings for the organization must be set to `selected_members`. + * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/set-codespaces-access-users"]; /** @@ -1981,678 +3689,1150 @@ export interface paths { * @deprecated * @description Codespaces for the specified users will no longer be billed to the organization. * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + * To use this endpoint, the access settings for the organization must be set to `selected_members`. + * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-codespaces-access-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets an organization development environment secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes an organization development environment secret using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization development environment 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/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization development environment 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/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization development environment 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/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Copilot seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * Gets information about an organization's Copilot subscription, including seat breakdown + * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. + * Only organization owners can configure and view details about the organization's Copilot Business subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing/seats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List all Copilot seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing/selected_teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add teams to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Purchases a GitHub Copilot seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Cancels the Copilot seat assignment for all members of each team specified. + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add users to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Cancels the Copilot seat assignment for each user specified. + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a summary of Copilot usage for organization members * @description **Note**: This endpoint is in beta and is subject to change. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. + * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + * Copilot usage metrics. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. */ get: operations["copilot/usage-metrics-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/credential-authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SAML SSO authorizations for an organization * @description Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on). * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-saml-sso-authorizations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/credential-authorizations/{credential_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a SAML SSO authorization for an organization * @description Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-saml-sso-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom repository roles in an organization * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-repo-roles"]; + put?: never; /** * Create a custom repository role * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-repo-role"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom repository role * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/get-custom-repo-role"]; + put?: never; + post?: never; /** * Delete a custom repository role * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-repo-role"]; + options?: never; + head?: never; /** * Update a custom repository role * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/update-custom-repo-role"]; + trace?: never; }; "/orgs/{org}/custom_roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Deprecated - Create a custom role * @deprecated * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. + * Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. * - * Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-role"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom_roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Deprecated - Get a custom role * @deprecated * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. + * Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. * - * Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/get-custom-role"]; + put?: never; + post?: never; /** * Deprecated - Delete a custom role * @deprecated * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. + * Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. * - * 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-role"]; + options?: never; + head?: never; /** * Deprecated - Update a custom role * @deprecated * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. + * Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. * - * Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/update-custom-role"]; + trace?: never; }; "/orgs/{org}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization + * permission to use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["dependabot/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public organization events */ get: operations["activity/list-public-org-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-group/{group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/failed_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List failed organization invitations * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ get: operations["orgs/list-failed-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/fine_grained_permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Deprecated - List fine-grained permissions for an organization * @deprecated * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. + * Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. * - * Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization. + * To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization webhooks * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** * Delete an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an organization * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook delivery for an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping an organization webhook * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks + * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations for an organization * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. + * all GitHub Apps installed on repositories in the organization. * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get interaction restrictions for an organization * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. @@ -2663,122 +4843,261 @@ export interface paths { * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ put: operations["interactions/set-restrictions-for-org"]; + post?: never; /** * Remove interaction restrictions for an organization * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ delete: operations["interactions/remove-restrictions-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pending organization invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. */ get: operations["orgs/list-pending-invitations"]; + put?: never; /** * Create an organization invitation * @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. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["orgs/create-invitation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Cancel an organization invitation * @description 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/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). */ delete: operations["orgs/cancel-invitation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/invitations/{invitation_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization invitation teams * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ get: operations["orgs/list-invitation-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-codespaces-for-user-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a codespace from the organization * @description Deletes a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-from-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Stop a codespace for an organization user * @description Stops a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/stop-in-organization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/copilot": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Copilot seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * Organization owners can view GitHub Copilot seat assignment details for members in their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. @@ -2788,498 +5107,921 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * - * **Rate limits** + * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization migrations * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). * - * A list of `repositories` is only returned for export migrations. + * A list of `repositories` is only returned for export migrations. */ get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. */ post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization migration status * @description Fetches the status of a migration. * - * The `state` of a migration can be one of the following values: + * The `state` of a migration can be one of the following values: * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization fine-grained permissions for an organization * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-organization-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all organization roles for an organization * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-roles"]; + put?: never; /** * Create a custom organization role * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-organization-role"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a team * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Assign an organization role to a team * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["orgs/assign-team-to-org-role"]; + post?: never; /** * Remove an organization role from a team * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a user * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Assign an organization role to a user * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["orgs/assign-user-to-org-role"]; + post?: never; /** * Remove an organization role from a user * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization role * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/get-org-role"]; + put?: never; + post?: never; /** * Delete a custom organization role. * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-organization-role"]; + options?: never; + head?: never; /** * Update a custom organization role * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/patch-custom-organization-role"]; + trace?: never; }; "/orgs/{org}/organization-roles/{role_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams that are assigned to an organization role * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization. + * To use this endpoint, you must be an administrator for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/{role_id}/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users that are assigned to an organization role * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization. + * To use this endpoint, you must be an administrator for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Convert an organization member to outside collaborator * @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/enterprise-cloud@latest//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)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; + put?: never; + post?: never; /** * Delete a package for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for an organization * @description Restores an entire package in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; + put?: never; + post?: never; /** * Delete package version for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for an organization * @description Restores a specific package version in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List requests to access organization resources with fine-grained personal access tokens * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-requests"]; + put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-requests-in-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review a request to access organization resources with a fine-grained personal access token * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories requested to be accessed by a fine-grained personal access token * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-request-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List fine-grained personal access tokens with access to organization resources * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grants"]; + put?: never; /** * Update the access to organization resources via fine-grained personal access tokens * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-accesses"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Update the access a fine-grained personal access token has to organization resources * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-access"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories a fine-grained personal access token has access to * @description Lists the repositories a fine-grained personal access token has access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-org"]; + put?: never; /** * Create an organization project * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/properties/schema": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. - * Organization members can read these properties. + * Organization members can read these properties. */ get: operations["orgs/get-all-custom-properties"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ patch: operations["orgs/create-or-update-custom-properties"]; + trace?: never; }; "/orgs/{org}/properties/schema/{custom_property_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. - * Organization members can read these properties. + * Organization members can read these properties. */ get: operations["orgs/get-custom-property"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ put: operations["orgs/create-or-update-custom-property"]; + post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ delete: operations["orgs/remove-custom-property"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom property values for organization repositories * @description Lists organization repositories with all of their custom property values. - * Organization members can read these properties. + * Organization members can read these properties. */ get: operations["orgs/list-custom-properties-values-for-repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for organization repositories * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. - * Each target repository will have its custom property values updated to match the values provided in the request. + * Each target repository will have its custom property values updated to match the values provided in the request. * - * A maximum of 30 repositories can be updated in a single request. + * A maximum of 30 repositories can be updated in a single request. * - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + trace?: never; }; "/orgs/{org}/public_members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. */ get: operations["orgs/list-public-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check public organization membership for a user * @description Check if the provided user is a public member of the organization. @@ -3289,71 +6031,145 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; + post?: never; /** * Remove public organization membership for the authenticated user * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization repositories * @description 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repository-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository fine-grained permissions for an organization * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-repo-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all organization repository rulesets * @description Get all the repository rulesets for an organization. */ get: operations["repos/get-org-rulesets"]; + put?: never; /** * Create an organization repository ruleset * @description Create a repository ruleset for an organization. */ post: operations["repos/create-org-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization rule suites * @description Lists suites of rule evaluations at the organization level. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ get: operations["repos/get-org-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization rule suite * @description Gets information about a suite of rule evaluations from within an organization. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ get: operations["repos/get-org-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. @@ -3364,1500 +6180,2771 @@ export interface paths { * @description Update a ruleset for an organization. */ put: operations["repos/update-org-ruleset"]; + post?: never; /** * Delete an organization repository ruleset * @description Delete a ruleset for an organization. */ delete: operations["repos/delete-org-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository security advisories for an organization * @description Lists repository security advisories for an organization. * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ get: operations["security-advisories/list-org-repository-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List security manager teams * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-security-manager-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a security manager team * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["orgs/add-security-manager-team"]; + post?: never; /** * Remove a security manager team * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-security-manager-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions billing for an organization * @description Gets the summary of the free and paid GitHub Actions minutes used. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an organization * @description 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. + * 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Packages billing for an organization * @description Gets the free and paid storage used for GitHub Packages in gigabytes. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/shared-storage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get shared storage billing for an organization * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/team-sync/groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List IdP groups for an organization * @description Lists IdP groups available in an organization. */ get: operations["teams/list-idp-groups-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a summary of Copilot usage for a team * @description **Note**: This endpoint is in beta and is subject to change. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. + * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. */ get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ get: operations["teams/list"]; + put?: never; /** * Create a team * @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/enterprise-cloud@latest//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/enterprise-cloud@latest//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/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Cloud replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-in-org"]; + put?: never; /** * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-in-org"]; + put?: never; + post?: never; /** * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-in-org"]; + options?: never; + head?: never; /** * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-in-org"]; + put?: never; /** * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * **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`. + * **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`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-in-org"]; + put?: never; + post?: never; /** * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-in-org"]; + options?: never; + head?: never; /** * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; + put?: never; /** * Create reaction for a team discussion comment * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; + put?: never; /** * Create reaction for a team discussion * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; + put?: never; + post?: never; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + options?: never; + head?: never; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ get: operations["teams/list-pending-invitations-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members * @description Team members will include the members of child teams. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user * @description Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//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. + * 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. * - * If 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. + * If 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. * - * **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}`. + * **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}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @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. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//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}`. + * **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}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; + post?: never; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." * - * **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}`. + * **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/enterprise-cloud@latest//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/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/team-sync/group-mappings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List IdP groups for a team * @description List IdP groups connected to a team on GitHub Enterprise Cloud. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ get: operations["teams/list-idp-groups-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update IdP group connections * @description Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. */ patch: operations["teams/create-or-update-idp-group-connections-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature for an organization * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/cards/{card_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project card * @description Gets information about a project card. */ get: operations["projects/get-card"]; + put?: never; + post?: never; /** * Delete a project card * @description Deletes a project card */ delete: operations["projects/delete-card"]; + options?: never; + head?: never; /** Update an existing project card */ patch: operations["projects/update-card"]; + trace?: never; }; "/projects/columns/cards/{card_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project card */ post: operations["projects/move-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project column * @description Gets information about a project column. */ get: operations["projects/get-column"]; + put?: never; + post?: never; /** * Delete a project column * @description Deletes a project column. */ delete: operations["projects/delete-column"]; + options?: never; + head?: never; /** Update an existing project column */ patch: operations["projects/update-column"]; + trace?: never; }; "/projects/columns/{column_id}/cards": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project cards * @description Lists the project cards in a project. */ get: operations["projects/list-cards"]; + put?: never; /** Create a project card */ post: operations["projects/create-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project column */ post: operations["projects/move-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/get"]; + put?: never; + post?: never; /** * Delete a project * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ delete: operations["projects/delete"]; + options?: never; + head?: never; /** * Update a project * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ patch: operations["projects/update"]; + trace?: never; }; "/projects/{project_id}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project collaborators * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ get: operations["projects/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add project collaborator * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ put: operations["projects/add-collaborator"]; + post?: never; /** * Remove user as a collaborator * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ delete: operations["projects/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get project permission for a user * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ get: operations["projects/get-permission-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/columns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project columns * @description Lists the project columns in a project. */ get: operations["projects/list-columns"]; + put?: never; /** * Create a project column * @description Creates a new project column. */ post: operations["projects/create-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/overview/api-versions)." + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/overview/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository * @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. * - * **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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List artifacts for a repository * @description Lists all artifacts for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an artifact * @description Gets a specific artifact for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an artifact * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. - * 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. + * 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. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-list"]; + put?: never; + post?: never; /** * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a job for a workflow run * @description Gets a specific job in a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. + * for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization secrets * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization variables * @description Lists all organization variables shared with a repository. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-variables"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-workflow-access-to-repository"]; /** * Set the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-workflow-access-to-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions and reusable workflows for a repository * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions for a repository * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings. + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." + * as well as if GitHub Actions can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." + * can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the repository. + * The authenticated user must have admin access to the repository. * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** * Set custom labels for a self-hosted runner for a repository * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. + * self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository * @description Adds custom labels to a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** * Remove all custom labels from a self-hosted runner for a repository * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. + * repository. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for a repository * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. + * in a repository. Returns the remaining labels from the runner. * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a repository * @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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run * @description Gets a specific workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Deletes a specific workflow run. * - * Anyone with write access to the repository can use this endpoint. + * Anyone with write access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the review history for a workflow run * @description Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-reviews-for-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/approve-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow run artifacts * @description Lists artifacts for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run attempt * @description Gets a specific workflow run attempt. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * **Note:** GitHub Apps can only review their own custom deployment protection rules. + * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ post: operations["actions/review-custom-gates-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Force cancel a workflow run * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. - * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/force-cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. + * `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @description Deletes all logs for a workflow run. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-pending-deployments-for-run"]; + put?: never; /** * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/review-pending-deployments-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a workflow * @description Re-runs your workflow run using its `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run failed jobs from a workflow run * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow-failed-jobs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get workflow run usage * @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 Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-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/enterprise-cloud@latest//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. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository variables * @description Lists all repository variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-variables"]; + put?: never; /** * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-repo-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository variable * @description Gets a specific variable in a repository. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-variable"]; + put?: never; + post?: never; /** * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-variable"]; + options?: never; + head?: never; /** * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-repo-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository workflows * @description Lists the workflows in a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow * @description Gets a specific workflow. You can replace `workflow_id` with the workflow - * file name. For example, you could use `main.yaml`. + * file name. For example, you could use `main.yaml`. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Disable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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`. * - * You 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)." + * You 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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a workflow * @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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint + * Anyone with read access to the repository can use this endpoint * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get workflow usage * @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 Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-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/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * 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. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository activities * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * - * For more information about viewing repository activity, - * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." + * For more information about viewing repository activity, + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." */ get: operations["repos/list-activities"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest//articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned * @description Checks if a user has permission to be assigned to an issue in this repository. * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. * - * Otherwise a `404` status code is returned. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an autolink reference of a repository * @description This returns a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if automated security fixes are enabled for a repository * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". @@ -4868,21 +8955,58 @@ export interface paths { * @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/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". */ put: operations["repos/enable-automated-security-fixes"]; + post?: never; /** * Disable 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/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". */ delete: operations["repos/disable-automated-security-fixes"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List branches */ get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a branch */ get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get branch protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -4892,106 +9016,161 @@ export interface paths { * Update branch protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Protecting a branch requires admin or owner permissions to the repository. + * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get admin branch protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pull request review protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit signature protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. + * When 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/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * **Note**: You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get status checks protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ patch: operations["repos/update-status-check-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all status check contexts * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -5012,1943 +9191,3285 @@ export interface paths { * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists who has access to this protected branch. + * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Disables the ability to restrict who can push to this branch. + * Disables the ability to restrict who can push to this branch. */ delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get apps with access to the protected branch * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * 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/enterprise-cloud@latest//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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * 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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get teams with access to the protected branch * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. The list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified teams push access for this branch. You can also give push access to child teams. + * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get users with access to the protected branch * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the people who have push access to this branch. + * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ put: operations["repos/set-user-access-restrictions"]; /** * Add user 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified people push access for this branch. + * Grants the specified people push access for this branch. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ post: operations["repos/add-user-access-restrictions"]; /** * Remove user 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a user to push to this branch. + * Removes the ability of a user to push to this branch. * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/rename": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rename a branch * @description Renames a branch in a repository. * - * **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/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". + * **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/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ post: operations["repos/rename-branch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check run * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ patch: operations["checks/update"]; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check run annotations * @description Lists annotations for a check run using the annotation `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch (or for the specified Git reference if you used `ref` in the request). * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning alert * @description Gets a single code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning analyses for a repository * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `category` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set: + * `next_analysis_url` and `confirm_delete_url`. + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in a set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find an analysis that's identified as deletable. + * Each set of analyses always has one that's identified as deletable. + * Having found the deletable analysis for one of the two sets, + * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + * Then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a CodeQL database for a repository * @description Gets a CodeQL database for a language in a repository. * - * By default this endpoint returns JSON metadata about the CodeQL database. To - * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types), and make sure - * your HTTP client is configured to follow redirects or use the `Location` header - * to make a second request to get the redirect URL. + * By default this endpoint returns JSON metadata about the CodeQL database. To + * download the CodeQL database binary content, set the `Accept` header of the request + * to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types), and make sure + * your HTTP client is configured to follow redirects or use the `Location` header + * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-default-setup"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-default-setup"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif)." * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - 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)." * - * You 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: + * You 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: * - * ``` - * gzip -c analysis-data.sarif | base64 -w0 - * ``` + * ``` + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. | + * | **SARIF data** | **Maximum values** | **Additional limits** | + * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| + * | Runs per file | 20 | | + * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * The `202 Accepted` response includes an `id` value. + * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS - * file. + * file. * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * For more information about the correct CODEOWNERS syntax, + * see "[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces in a repository for the authenticated user * @description Lists the codespaces associated to a specified repository and the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-in-repository-for-authenticated-user"]; + put?: never; /** * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-repo-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/devcontainers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List devcontainer configurations in a repository for the authenticated user * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files - * specify launchpoint configurations for codespaces created within the repository. + * specify launchpoint configurations for codespaces created within the repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List available machine types for a repository * @description List the machine types available for a given repository based on its configuration. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/repo-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/new": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default attributes for a codespace * @description Gets the default attributes for codespaces created by the user with the repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/permissions_check": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if permissions defined by a devcontainer have been accepted by the authenticated user * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/check-permissions-for-devcontainer"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all development environment secrets available in a repository without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository development environment secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["codespaces/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["codespaces/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is a repository collaborator * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/check-collaborator"]; /** * Add a repository collaborator * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * 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)." + * 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/enterprise-cloud@latest//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: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//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: * - * ``` - * Cannot assign {member} permission of {role name} - * ``` + * ``` + * Cannot assign {member} permission of {role name} + * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations). + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations). * - * **Updating an existing collaborator's permission level** + * **Updating an existing collaborator's permission level** * - * The 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. + * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. * - * **Rate limits** + * **Rate limits** * - * You 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. + * You 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. */ put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. + * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages + * This endpoint also: + * - Cancels any outstanding invitations + * - Unasigns the user from any issues + * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. + * - Unstars the repository + * - Updates access permissions to packages * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + * Removing a user as a collaborator has the following effects on forks: + * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + * - If the user had their own fork of the repository, the fork will be deleted. + * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. + * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository permissions for a user * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * permissions are `admin`, `write`, `read`, and `none`. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the + * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. */ get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["repos/update-commit-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List branches for HEAD commit * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests associated with a commit * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * - * **Signature verification object** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the combined status for a specific reference * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * * - * Additionally, a combined `state` is returned. The `state` is one of: + * Additionally, a combined `state` is returned. The `state` is one of: * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` */ get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit statuses for a reference * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/community/profile": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get community profile metrics * @description Returns all community profile metrics for a repository. The repository 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, - * README, and CONTRIBUTING files. + * 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, + * README, and CONTRIBUTING files. * - * The `health_percentage` score is defined as a percentage of how many of - * the recommended community health files are present. For more information, see - * "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." + * The `health_percentage` score is defined as a percentage of how many of + * the recommended community health files are present. For more information, see + * "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." * - * `content_reports_enabled` is only returned for organization-owned repositories. + * `content_reports_enabled` is only returned for organization-owned repositories. */ get: operations["repos/get-community-profile-metrics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * - * 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 API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. + * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. * - * **Working with large comparisons** + * **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: + * 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. + * - 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. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." * - * **Signature verification object** + * **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 `verification` object includes the following fields: * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits-with-basehead"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * - * **Notes**: + * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository contributors * @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. * - * 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. + * 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. */ get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for a repository * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a Dependabot alert * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a Dependabot alert * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["dependabot/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @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. + * encrypt a secret before you can create or update secrets. Anyone with read access + * to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ get: operations["dependabot/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["dependabot/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["dependabot/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a diff of the dependencies between commits * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */ get: operations["dependency-graph/diff-range"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/sbom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Export a software bill of materials (SBOM) for a repository. * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. */ get: operations["dependency-graph/export-sbom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a snapshot of dependencies for a repository * @description Create a new snapshot of a repository's dependencies. * - * The authenticated user must have access to the repository. + * The authenticated user must have access to the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["dependency-graph/create-repository-snapshot"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them - * before we merge a pull request. + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them + * before we merge a pull request. * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. + * By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. * - * Merged branch response: + * Merged branch response: * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. * - * Merge conflict response: + * Merge conflict response: * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. * - * Failed commit status checks: + * Failed commit status checks: * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deployment */ get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * 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. * - * To set a deployment as inactive, you must: + * To set a deployment as inactive, you must: * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. + * * 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/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#repository_dispatch)." * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * This input example shows how you can use the `client_payload` as a test to debug your workflow. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment * @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)." * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-environment"]; /** * Create or update an environment * @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)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment branch policy * @description Gets a deployment branch or tag policy for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all deployment protection rules for an environment * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-deployment-protection-rules"]; + put?: never; /** * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-protection-rule"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom deployment rule integrations available for an environment * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)". * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-custom-deployment-rule-integrations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom deployment protection rule * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-custom-deployment-protection-rule"]; + put?: never; + post?: never; /** * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/disable-deployment-protection-rule"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment secrets * @description Lists all secrets available in an environment without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment public key * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. + * 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. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment secret * @description Gets a single environment secret without revealing its encrypted value. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-secret"]; /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-environment-secret"]; + post?: never; /** * Delete an environment secret * @description Deletes a secret in an environment using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment variables * @description Lists all environment variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-variables"]; + put?: never; /** * Create an environment variable * @description Create an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment variable * @description Gets a specific variable in an environment. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; /** * Delete an environment variable * @description Deletes an environment variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; /** * Update an environment variable * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-environment-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * */ get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List forks */ get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * - **`application/vnd.github.raw+json`**: Returns the raw blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. * - * **Note** This endpoint supports blobs up to 100 megabytes in size. + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit object * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." + * + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List matching references * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a reference * @description Deletes the provided reference. */ delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** * Update a reference * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ patch: operations["git/update-ref"]; + trace?: never; }; "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tag * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference)." * - * Returns an error if you try to delete a file that does not exist. + * Returns an error if you try to delete a file that does not exist. */ post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tree * @description Returns a single tree using the SHA1 value or ref name for that tree. * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. + * share the same `config` as long as those webhooks do not have any `events` that overlap. */ post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/import": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an import status * @deprecated * @description View the progress of an import. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Import status** + * **Import status** * - * This section includes details about the possible values of the `status` field of the Import Progress response. + * This section includes details about the possible values of the `status` field of the Import Progress response. * - * An import that does not have errors will progress through these steps: + * An import that does not have errors will progress through these steps: * - * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. - * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). - * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. - * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". - * * `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud. + * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud. * - * If there are problems, you will see one of these in the `status` field: + * If there are problems, you will see one of these in the `status` field: * - * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. - * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. - * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. - * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL. - * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. + * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. + * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. + * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL. + * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. * - * **The project_choices field** + * **The project_choices field** * - * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. * - * **Git LFS related fields** + * **Git LFS related fields** * - * This section includes details about Git LFS related fields that may be present in the Import Progress response. + * This section includes details about Git LFS related fields that may be present in the Import Progress response. * - * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. - * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. - * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. - * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ get: operations["migrations/get-import-status"]; /** * Start an import * @deprecated * @description Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. - * Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will - * return a status `422 Unprocessable Entity` response. + * Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; + post?: never; /** * Cancel an import * @deprecated * @description Stop an import for a repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ delete: operations["migrations/cancel-import"]; + options?: never; + head?: never; /** * Update an import * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API - * request. If no parameters are provided, the import will be restarted. + * request. If no parameters are provided, the import will be restarted. * - * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will - * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. - * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. + * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will + * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. + * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; + trace?: never; }; "/repos/{owner}/{repo}/import/authors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit authors * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * - * This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. + * This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/import/authors/{author_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Map a commit author * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push - * new commits to the repository. + * new commits to the repository. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; + trace?: never; }; "/repos/{owner}/{repo}/import/large_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get large files * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ get: operations["migrations/get-large-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/import/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update Git LFS preference * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability - * is powered by [Git LFS](https://git-lfs.com). + * is powered by [Git LFS](https://git-lfs.com). + * + * You can learn more about our LFS feature and working with large files [on our help + * site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). * - * You can learn more about our LFS feature and working with large files [on our help - * site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; + trace?: never; }; "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get interaction restrictions for a repository * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. @@ -6959,178 +12480,315 @@ export interface paths { * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ put: operations["interactions/set-restrictions-for-repo"]; + post?: never; /** * Remove interaction restrictions for a repository * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ delete: operations["interactions/remove-restrictions-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ patch: operations["repos/update-invitation"]; + trace?: never; }; "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments for a repository * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * - * By default, issue comments are ordered by ascending ID. + * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events for a repository * @description Lists events for a repository. */ get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue event * @description Gets a single event by the event id. */ get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook. + * [transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * 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/enterprise-cloud@latest//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 - * 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/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. @@ -7141,59 +12799,107 @@ export interface paths { * @description Removes one or more assignees from an issue. */ delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned to a issue * @description 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. + * 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. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * Issue comments are ordered by ascending ID. + * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events * @description Lists all events for an issue. */ get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for an issue * @description Lists all labels for an issue. @@ -7214,183 +12920,403 @@ export interface paths { * @description Removes all labels from an issue. */ delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List deploy keys */ get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deploy key */ get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a repository * @description Lists all labels for a repository. */ get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a label * @description Gets a label using the given name. */ get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ patch: operations["issues/update-label"]; + trace?: never; }; "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable Git LFS for a repository * @description Enables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["repos/enable-lfs-for-repo"]; + post?: never; /** * Disable Git LFS for a repository * @description Disables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["repos/disable-lfs-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List milestones * @description Lists milestones for a repository. */ get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ patch: operations["issues/update-milestone"]; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. @@ -7401,118 +13327,230 @@ export interface paths { * @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 Enterprise Cloud 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/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GitHub Enterprise Cloud Pages site * @description Gets information about a GitHub Enterprise Cloud Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub Enterprise Cloud Pages site * @description Updates information for a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Enterprise Cloud Pages site * @description Configures a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub Enterprise Cloud Pages site * @description Deletes a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Enterprise Cloud Pages builds * @description Lists builts of a GitHub Enterprise Cloud Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub Enterprise Cloud Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Enterprise Cloud Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Enterprise Cloud Pages build * @description Gets information about a GitHub Enterprise Cloud Pages build. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * The authenticated user must have write permission to the repository. + * The authenticated user must have write permission to the repository. */ post: operations["repos/create-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the status of a GitHub Pages deployment * @description Gets the current status of a GitHub Pages deployment. * - * The authenticated user must have read permission for the GitHub Pages site. + * The authenticated user must have read permission for the GitHub Pages site. */ get: operations["repos/get-pages-deployment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a GitHub Pages deployment * @description Cancels a GitHub Pages deployment. * - * The authenticated user must have write permissions for the GitHub Pages site. + * The authenticated user must have write permissions for the GitHub Pages site. */ post: operations["repos/cancel-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/health": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a DNS health check for GitHub Pages * @description Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * - * 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. + * 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. * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-health-check"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if private vulnerability reporting is enabled for a repository * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". @@ -7523,280 +13561,452 @@ export interface paths { * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." */ put: operations["repos/enable-private-vulnerability-reporting"]; + post?: never; /** * Disable private vulnerability reporting for a repository * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". */ delete: operations["repos/disable-private-vulnerability-reporting"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-repo"]; + put?: never; /** * Create a repository project * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all custom property values for a repository * @description Gets all custom property values that are set for a repository. - * Users with read access to the repository can use this endpoint. + * Users with read access to the repository can use this endpoint. */ get: operations["repos/get-custom-properties-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for a repository * @description Create new or update existing custom property values for a repository. - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ patch: operations["repos/create-or-update-custom-properties-values"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests * @description Lists pull requests in a specified repository. * - * 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. + * 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments in a repository * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. + * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists details of a pull request by providing its number. + * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-pr-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments on a pull request * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. + * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment)." * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reply for a review comment * @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. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits) - * endpoint. + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits) + * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. @@ -7805,16 +14015,29 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. @@ -7825,317 +14048,589 @@ export interface paths { * @description Removes review requests from a pull request for a given set of users and/or teams. */ delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * 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/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/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. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List releases * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags). * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release asset * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ patch: operations["repos/update-release-asset"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/generate-notes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Generate release notes content for a release * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the latest release * @description View the latest published full release for the repository. * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ patch: operations["repos/update-release"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List release assets */ get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) to upload a release asset. + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) to upload a release asset. * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: * - * `application/zip` + * `application/zip` * - * GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. + * GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * - * **Notes:** - * * GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + * **Notes:** + * * GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rules/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rules for a branch * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply - * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level - * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" - * enforcement statuses are not returned. + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. */ get: operations["repos/get-branch-rules"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all repository rulesets * @description Get all the rulesets for a repository. */ get: operations["repos/get-repo-rulesets"]; + put?: never; /** * Create a repository ruleset * @description Create a ruleset for a repository. */ post: operations["repos/create-repo-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository rule suites * @description Lists suites of rule evaluations at the repository level. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ get: operations["repos/get-repo-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository rule suite * @description Gets information about a suite of rule evaluations from within a repository. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ get: operations["repos/get-repo-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository ruleset * @description Get a ruleset for a repository. @@ -8146,213 +14641,430 @@ export interface paths { * @description Update a ruleset for a repository. */ put: operations["repos/update-repo-ruleset"]; + post?: never; /** * Delete a repository ruleset * @description Delete a ruleset for a repository. */ delete: operations["repos/delete-repo-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["secret-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository security advisories * @description Lists security advisories in a repository. * - * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/list-repository-advisories"]; + put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. * - * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/reports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Privately report a security vulnerability * @description Report a security vulnerability to the maintainers of the repository. - * See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. + * See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. */ post: operations["security-advisories/create-private-vulnerability-report"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository security advisory * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. * - * Anyone can access any published security advisory on a public repository. + * Anyone can access any published security advisory on a public repository. * - * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a - * collaborator on the security advisory. + * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a + * collaborator on the security advisory. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/get-repository-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. * - * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, - * or a collaborator on the repository security advisory. + * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, + * or a collaborator on the repository security advisory. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ patch: operations["security-advisories/update-repository-advisory"]; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Request a CVE for a repository security advisory * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." * - * You may request a CVE for public repositories, but cannot do so for private repositories. + * You may request a CVE for public repositories, but cannot do so for private repositories. * - * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory-cve-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ post: operations["security-advisories/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit activity * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all contributor commit activity * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit count * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * - * The array order is oldest week (index 0) to most recent week. + * The array order is oldest week (index 0) to most recent week. * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. + * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the hourly commit count for each day * @description Each array contains the day number, hour number, and number of commits: * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List watchers * @description Lists the people watching the specified repository. */ get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. @@ -8363,102 +15075,254 @@ export interface paths { * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List repository tags */ get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List tag protection states for a repository * @description This returns the tag protection states of a repository. * - * This information is only available to repository administrators. + * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; + put?: never; /** * Create a tag protection state for a repository * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a tag protection state for a repository * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (tar) * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * `main`) 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. */ get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository teams * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. * - * For a public repository, a team is listed only if that team added the public repository explicitly. + * For a public repository, a team is listed only if that team added the public repository explicitly. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all repository topics */ get: operations["repos/get-all-topics"]; /** Replace all repository topics */ put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/clones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository clones * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ get: operations["repos/get-clones"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/popular/paths": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get top referral paths * @description Get the top 10 popular contents over the last 14 days. */ get: operations["repos/get-top-paths"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/popular/referrers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get top referral sources * @description Get the top 10 referrers over the last 14 days. */ get: operations["repos/get-top-referrers"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get page views * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ get: operations["repos/get-views"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/). */ post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if vulnerability alerts are enabled for a repository * @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/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". @@ -8469,573 +15333,887 @@ export interface paths { * @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/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". */ put: operations["repos/enable-vulnerability-alerts"]; + post?: never; /** * Disable vulnerability alerts * @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/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". + * The authenticated user must have admin access to the repository. For more information, + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". */ delete: operations["repos/disable-vulnerability-alerts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (zip) * @description 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 - * the `Location` header to make a second `GET` request. + * `main`) 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. + * **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. */ get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public repositories * @description Lists all public repositories in the order that they were created. * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Lists provisioned SCIM groups in an enterprise. + * Lists provisioned SCIM groups in an enterprise. * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. + * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. */ get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + put?: never; /** * Provision a SCIM enterprise group * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Creates a SCIM group for an enterprise. + * Creates a SCIM group for an enterprise. * - * When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. + * When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. */ post: operations["enterprise-admin/provision-enterprise-group"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise group * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Gets information about a SCIM group. + * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Replaces an existing provisioned group’s information. + * Replaces an existing provisioned group’s information. * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + post?: never; /** * Delete a SCIM group from an enterprise * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise group * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Update a provisioned group’s individual attributes. + * Update a provisioned group’s individual attributes. * - * To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. + * To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. * - * You can submit group memberships individually or in batches for improved efficiency. + * You can submit group memberships individually or in batches for improved efficiency. * - * **Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here. + * **Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here. */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SCIM provisioned identities for an enterprise * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Lists provisioned SCIM enterprise members. + * Lists provisioned SCIM enterprise members. * - * When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. + * When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. */ get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + put?: never; /** * Provision a SCIM enterprise user * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Creates an external identity for a new SCIM enterprise user. + * Creates an external identity for a new SCIM enterprise user. * - * SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. + * SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. */ post: operations["enterprise-admin/provision-enterprise-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise user * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Gets information about a SCIM user. + * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Replaces an existing provisioned user's information. + * Replaces an existing provisioned user's information. * - * You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. + * You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. + * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + post?: never; /** * Delete a SCIM user from an enterprise * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. * - * Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. + * Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise user * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. * - * Update a provisioned user's individual attributes. + * Update a provisioned user's individual attributes. * - * To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. + * **Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. + * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] * } - * }] - * } - * ``` + * ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; + trace?: never; }; "/scim/v2/organizations/{org}/Users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SCIM provisioned identities * @description Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. * - * When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub Enterprise Cloud. This can happen in certain cases where an external identity associated with an organization will not match an organization member: - * - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. - * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). - * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. + * When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub Enterprise Cloud. This can happen in certain cases where an external identity associated with an organization will not match an organization member: + * - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. + * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). + * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. * - * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub Enterprise Cloud account after completing SSO: + * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub Enterprise Cloud account after completing SSO: * - * 1. The user is granted access by the IdP and is not a member of the GitHub Enterprise Cloud organization. + * 1. The user is granted access by the IdP and is not a member of the GitHub Enterprise Cloud organization. * - * 1. The user attempts to access the GitHub Enterprise Cloud organization and initiates the SAML SSO process, and is not currently signed in to their GitHub Enterprise Cloud account. + * 1. The user attempts to access the GitHub Enterprise Cloud organization and initiates the SAML SSO process, and is not currently signed in to their GitHub Enterprise Cloud account. * - * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub Enterprise Cloud account: - * - If the user signs in, their GitHub Enterprise Cloud account is linked to this entry. - * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub Enterprise Cloud organization, and the external identity `null` entry remains in place. + * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub Enterprise Cloud account: + * - If the user signs in, their GitHub Enterprise Cloud account is linked to this entry. + * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub Enterprise Cloud organization, and the external identity `null` entry remains in place. */ get: operations["scim/list-provisioned-identities"]; + put?: never; /** * Provision and invite a SCIM user * @description Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see "[Reinstating a former member of your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." */ post: operations["scim/provision-and-invite-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/organizations/{org}/Users/{scim_user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get SCIM provisioning information for a user */ get: operations["scim/get-provisioning-information-for-user"]; /** * Update a provisioned organization membership * @description Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead. * - * You must at least provide the required values for the user: `userName`, `name`, and `emails`. + * You must at least provide the required values for the user: `userName`, `name`, and `emails`. * - * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. + * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. */ put: operations["scim/set-information-for-provisioned-user"]; + post?: never; /** Delete a SCIM user from an organization */ delete: operations["scim/delete-user-from-org"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM user * @description Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. * - * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. + * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] * } - * }] - * } - * ``` + * ``` */ patch: operations["scim/update-attribute-for-user"]; + trace?: never; }; "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * - * `q=addClass+in:file+language:js+repo:jquery/jquery` + * `q=addClass+in:file+language:js+repo:jquery/jquery` * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. * - * Considerations for code search: + * Considerations for code search: * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. * - * This endpoint requires you to authenticate and limits you to 10 requests per minute. + * This endpoint requires you to authenticate and limits you to 10 requests per minute. */ get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search commits * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). * - * 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/enterprise-cloud@latest//rest/search/search#text-match-metadata). + * 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/enterprise-cloud@latest//rest/search/search#text-match-metadata). * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * - * `q=repo:octocat/Spoon-Knife+css` + * `q=repo:octocat/Spoon-Knife+css` */ get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search issues and pull requests * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * - * `q=bug+defect+enhancement&repository_id=64778136` + * `q=bug+defect+enhancement&repository_id=64778136` * - * The labels that best match the query appear first in the search results. + * The labels that best match the query appear first in the search results. */ get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * - * `q=tetris+language:assembly&sort=stars&order=desc` + * `q=tetris+language:assembly&sort=stars&order=desc` * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * - * `q=ruby+is:featured` + * `q=ruby+is:featured` * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). * - * For example, if you're looking for a list of popular users, you might try this query: + * For example, if you're looking for a list of popular users, you might try this query: * - * `q=tom+repos:%3E42+followers:%3E1000` + * `q=tom+repos:%3E42+followers:%3E1000` * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search)." */ get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. * - * To delete a team, the authenticated user must be an organization owner or team maintainer. + * To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. + * List all discussions on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-legacy"]; + put?: never; /** * Create a discussion (Legacy) * @deprecated * @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/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. + * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. + * Get a specific discussion on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-legacy"]; + put?: never; + post?: never; /** * Delete a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. + * Delete a discussion from a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-legacy"]; + options?: never; + head?: never; /** * Update a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. + * List all comments on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-legacy"]; + put?: never; /** * Create a discussion comment (Legacy) * @deprecated * @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/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. + * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. + * Get a specific comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-legacy"]; + put?: never; + post?: never; /** * Delete a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. + * Deletes a comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-legacy"]; + options?: never; + head?: never; /** * Update a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. + * Edits the body text of a discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; + put?: never; /** * Create reaction for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-legacy"]; + put?: never; /** * Create reaction for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pending team invitations (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. * - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. */ get: operations["teams/list-pending-invitations-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. */ get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team member (Legacy) * @deprecated * @description The "Get team member" endpoint (described below) is deprecated. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/get-member-legacy"]; /** @@ -9043,46 +16221,57 @@ export interface paths { * @deprecated * @description The "Add team member" endpoint (described below) is deprecated. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated * @description The "Remove team member" endpoint (described below) is deprecated. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** @@ -9090,47 +16279,71 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * - * If 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. + * If 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. */ put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//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. + * 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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint. * - * Lists the organization projects for a team. + * Lists the organization projects for a team. */ get: operations["teams/list-projects-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint. * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ get: operations["teams/check-permissions-for-project-legacy"]; /** @@ -9138,35 +16351,59 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint. * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ put: operations["teams/add-or-update-project-permissions-legacy"]; + post?: never; /** * Remove a project from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint. * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ delete: operations["teams/remove-project-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository (Legacy) * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** @@ -9174,70 +16411,131 @@ export interface paths { * @deprecated * @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/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * - * 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. + * 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/team-sync/group-mappings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List IdP groups for a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * List IdP groups connected to a team on GitHub Enterprise Cloud. + * List IdP groups connected to a team on GitHub Enterprise Cloud. */ get: operations["teams/list-idp-groups-for-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update IdP group connections (Legacy) * @deprecated * @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 or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. + * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. */ patch: operations["teams/create-or-update-idp-group-connections-legacy"]; + trace?: never; }; "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ patch: operations["users/update-authenticated"]; + trace?: never; }; "/user/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users blocked by the authenticated user * @description List the users you've blocked on your personal account. */ get: operations["users/list-blocked-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is blocked by the authenticated user * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. @@ -9248,233 +16546,433 @@ export interface paths { * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. */ put: operations["users/block"]; + post?: never; /** * Unblock a user * @description Unblocks the given user and returns a 204. */ delete: operations["users/unblock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces for the authenticated user * @description Lists the authenticated user's codespaces. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-for-authenticated-user"]; + put?: never; /** * Create a codespace for the authenticated user * @description Creates a new codespace, owned by the authenticated user. * - * This endpoint requires either a `repository_id` OR a `pull_request` but not both. + * This endpoint requires either a `repository_id` OR a `pull_request` but not both. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secrets for the authenticated user * @description Lists all development environment secrets available for a user's codespaces without revealing their - * encrypted values. + * encrypted values. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-secrets-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get public key for the authenticated user * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-public-key-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret for the authenticated user * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + post?: never; /** * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/delete-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for a user secret * @description List the repositories that have been granted the ability to use a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a codespace for the authenticated user * @description Gets information about a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ delete: operations["codespaces/delete-for-authenticated-user"]; + options?: never; + head?: never; /** * Update a codespace for the authenticated user * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * - * If you specify a new machine type it will be applied the next time your codespace is started. + * If you specify a new machine type it will be applied the next time your codespace is started. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ patch: operations["codespaces/update-for-authenticated-user"]; + trace?: never; }; "/user/codespaces/{codespace_name}/exports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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. * - * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. + * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/export-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/exports/{export_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get details about a codespace export * @description Gets information about an export of a codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-export-details-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List machine types for a codespace * @description List the machine types a codespace can transition to use. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/codespace-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository from an unpublished codespace * @description 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. + * 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. + * This will fail for a codespace that is already published, meaning it has an associated repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/publish-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/start": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a codespace for the authenticated user * @description Starts a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Stop a codespace for the authenticated user * @description Stops a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/stop-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/email/visibility": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set primary email visibility for the authenticated user * @description Sets the visibility for your primary email addresses. */ patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; + trace?: never; }; "/user/emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List email addresses for the authenticated user * @description Lists all of your email addresses, and specifies which one is visible - * to the public. + * to the public. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-emails-for-authenticated-user"]; + put?: never; /** * Add an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. @@ -9485,104 +16983,213 @@ export interface paths { * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-email-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a person is followed by the authenticated user */ get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for the authenticated user * @description Lists the current user's GPG keys. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GPG key for the authenticated user * @description View extended details for a single GPG key. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You can find the permissions for the installation under the `permissions` key. + * You can find the permissions for the installation under the `permissions` key. */ get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the user access token * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * The access the user has to each repository is included in the hash under the `permissions` key. + * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get interaction restrictions for your public repositories * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires. @@ -9593,367 +17200,729 @@ export interface paths { * @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. */ put: operations["interactions/set-restrictions-for-authenticated-user"]; + post?: never; /** * Remove interaction restrictions from your public repositories * @description Removes any interaction restrictions from your public repositories. */ delete: operations["interactions/remove-restrictions-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user account issues assigned to the authenticated user * @description 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 - * 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/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public SSH keys for the authenticated user * @description Lists the public SSH keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a public SSH key for the authenticated user * @description View extended details for a single public SSH key. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/marketplace_purchases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List subscriptions for the authenticated user * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/marketplace_purchases/stubbed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List subscriptions for the authenticated user (stubbed) * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user migrations * @description Lists all migrations a user has started. */ get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user migration status * @description Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * - * * `pending` - the migration hasn't started yet. - * * `exporting` - the migration is in progress. - * * `exported` - the migration finished successfully. - * * `failed` - the migration failed. + * * `pending` - the migration hasn't started yet. + * * `exporting` - the migration is in progress. + * * `exported` - the migration finished successfully. + * * `failed` - the migration failed. * - * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive). + * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive). */ get: operations["migrations/get-status-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a user migration archive * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a user migration archive * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ delete: operations["migrations/delete-archive-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock a user repository * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ delete: operations["migrations/unlock-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package for the authenticated user * @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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for the authenticated user * @description Restores a package owned by the authenticated user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package version for the authenticated user * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. + * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package version for the authenticated user * @description Restores a package version owned by the authenticated user. * - * You can restore a deleted package version under the following conditions: - * - 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. + * You can restore a deleted package version under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user project * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/public_emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-public-emails-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for the authenticated user * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; "/user/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for the authenticated user * @description Lists all of your social accounts. */ get: operations["users/list-social-accounts-for-authenticated-user"]; + put?: never; /** * Add social accounts for the authenticated user * @description Add one or more social accounts to the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user * @description Deletes one or more social accounts from the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-social-account-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for the authenticated user * @description Lists the SSH signing keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; + put?: never; /** * Create a SSH signing key for the authenticated user * @description Creates an SSH signing key for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ post: operations["users/create-ssh-signing-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys/{ssh_signing_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an SSH signing key for the authenticated user * @description Gets extended details for an SSH signing key. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/get-ssh-signing-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete an SSH signing key for the authenticated user * @description Deletes an SSH signing key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. @@ -9964,384 +17933,866 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams for the authenticated user * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. + * user belongs. * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails)". */ get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. */ get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a user */ get: operations["activity/list-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of a user * @description Lists the people following the specified user. */ get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a user follows another user */ get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for a user * @description Lists public gists for the specified user: */ get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for a user * @description List [public organization memberships](https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; + put?: never; + post?: never; /** * Delete a package for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for a user * @description Restores an entire package for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; + put?: never; + post?: never; /** * Delete package version for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for a user * @description Restores a specific package version for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user projects * @description Lists projects for a user. */ get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events received by the authenticated user * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ get: operations["activity/list-received-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events received by a user */ get: operations["activity/list-received-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/settings/billing/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions billing for a user * @description Gets the summary of the free and paid GitHub Actions minutes used. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/settings/billing/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Packages billing for a user * @description Gets the free and paid storage used for GitHub Packages in gigabytes. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/settings/billing/shared-storage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get shared storage billing for a user * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for a user * @description Lists social media accounts for a user. This endpoint is accessible by anyone. */ get: operations["users/list-social-accounts-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for a user * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. */ get: operations["users/list-ssh-signing-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all API versions * @description Get all supported GitHub Enterprise Cloud API versions. */ get: operations["meta/get-all-versions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{base}...{head}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. * - * 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. + * 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. * - * 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. + * 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** + * **Working with large comparisons** * - * 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)." + * 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)." * - * 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. + * 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** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } - export type webhooks = Record; - export interface components { schemas: { root: { @@ -10446,7 +18897,7 @@ export interface components { /** @description The package version that resolves the vulnerability. */ first_patched_version: string | null; /** @description The functions in the package that are affected by the vulnerability. */ - vulnerable_functions: readonly string[] | null; + readonly vulnerable_functions: string[] | null; }; /** * Simple User @@ -10535,21 +18986,21 @@ export interface components { /** @description A GitHub Security Advisory. */ "global-advisory": { /** @description The GitHub Security Advisory ID. */ - ghsa_id: string; + readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - cve_id: string | null; + readonly cve_id: string | null; /** @description The API URL for the advisory. */ - url: string; + readonly url: string; /** * Format: uri * @description The URL for the advisory. */ - html_url: string; + readonly html_url: string; /** * Format: uri * @description The API URL for the repository advisory. */ - repository_advisory_url: string | null; + readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ summary: string; /** @description A detailed description of what the advisory entails. */ @@ -10558,7 +19009,7 @@ export interface components { * @description The type of advisory. * @enum {string} */ - type: "reviewed" | "unreviewed" | "malware"; + readonly type: "reviewed" | "unreviewed" | "malware"; /** * @description The severity of the advisory. * @enum {string} @@ -10569,8 +19020,8 @@ export interface components { * @description The URL of the advisory's source code. */ source_code_location: string | null; - identifiers: - | readonly { + readonly identifiers: + | { /** * @description The type of identifier. * @enum {string} @@ -10585,47 +19036,47 @@ export interface components { * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. */ - published_at: string; + readonly published_at: string; /** * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - updated_at: string; + readonly updated_at: string; /** * Format: date-time * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. */ - github_reviewed_at: string | null; + readonly github_reviewed_at: string | null; /** * Format: date-time * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. - * This field is only populated when the advisory is imported from the National Vulnerability Database. + * This field is only populated when the advisory is imported from the National Vulnerability Database. */ - nvd_published_at: string | null; + readonly nvd_published_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. */ - withdrawn_at: string | null; + readonly withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; /** @description The CVSS score. */ - score: number | null; + readonly score: number | null; } | null; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ - name: string; + readonly name: string; }[] | null; /** @description The users who contributed to the advisory. */ - credits: - | readonly { + readonly credits: + | { user: components["schemas"]["simple-user"]; type: components["schemas"]["security-advisory-credit-types"]; }[] @@ -10767,9 +19218,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -10782,9 +19233,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -11076,11 +19527,11 @@ export interface components { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ "app-permissions": { /** @@ -11376,12 +19827,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -11615,7 +20064,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -11648,7 +20097,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -11660,7 +20109,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -11681,69 +20130,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -11752,14 +20201,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -11783,12 +20232,10 @@ export interface components { single_file?: string; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; }; /** Scoped Installation */ @@ -11803,12 +20250,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** * Format: uri @@ -12242,53 +20687,52 @@ export interface components { * @example https://api.github.com/codes_of_conduct/contributor_covenant */ url: string; - /** - * @example # Contributor Covenant Code of Conduct + /** @example # Contributor Covenant Code of Conduct * - * ## Our Pledge + * ## Our Pledge * - * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. * - * ## Our Standards + * ## Our Standards * - * Examples of behavior that contributes to creating a positive environment include: + * Examples of behavior that contributes to creating a positive environment include: * - * * Using welcoming and inclusive language - * * Being respectful of differing viewpoints and experiences - * * Gracefully accepting constructive criticism - * * Focusing on what is best for the community - * * Showing empathy towards other community members + * * Using welcoming and inclusive language + * * Being respectful of differing viewpoints and experiences + * * Gracefully accepting constructive criticism + * * Focusing on what is best for the community + * * Showing empathy towards other community members * - * Examples of unacceptable behavior by participants include: + * Examples of unacceptable behavior by participants include: * - * * The use of sexualized language or imagery and unwelcome sexual attention or advances - * * Trolling, insulting/derogatory comments, and personal or political attacks - * * Public or private harassment - * * Publishing others' private information, such as a physical or electronic address, without explicit permission - * * Other conduct which could reasonably be considered inappropriate in a professional setting + * * The use of sexualized language or imagery and unwelcome sexual attention or advances + * * Trolling, insulting/derogatory comments, and personal or political attacks + * * Public or private harassment + * * Publishing others' private information, such as a physical or electronic address, without explicit permission + * * Other conduct which could reasonably be considered inappropriate in a professional setting * - * ## Our Responsibilities + * ## Our Responsibilities * - * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - * to any instances of unacceptable behavior. + * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + * to any instances of unacceptable behavior. * - * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. * - * ## Scope + * ## Scope * - * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. * - * ## Enforcement + * ## Enforcement * - * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. * - * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. * - * ## Attribution + * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - */ + * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + * */ body?: string; /** Format: uri */ html_url: string | null; @@ -12522,12 +20966,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -12608,12 +21052,10 @@ export interface components { * @example 2016-07-11T22:14:10Z */ expires_at: string; - /** - * @example { - * "issues": "read", - * "deployments": "write" - * } - */ + /** @example { + * "issues": "read", + * "deployments": "write" + * } */ permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; @@ -12735,32 +21177,32 @@ export interface components { | "dismissed" | "fixed"; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string} @@ -12770,12 +21212,12 @@ export interface components { * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -12814,10 +21256,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ "code-scanning-analysis-analysis-key": string; @@ -12855,10 +21295,8 @@ export interface components { }; location?: components["schemas"]["code-scanning-alert-location"]; html_url?: string; - /** - * @description Classifications that have been applied to the file that triggered the alert. - * For example identifying it as documentation, or a generated file. - */ + /** @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. */ classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; /** @@ -13124,7 +21562,7 @@ export interface components { "enterprise-security-analysis-settings": { /** * @description Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to - * this enterprise. + * this enterprise. * @example false */ advanced_security_enabled_for_new_repositories: boolean; @@ -13135,19 +21573,19 @@ export interface components { advanced_security_enabled_for_new_user_namespace_repositories?: boolean; /** * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ dependabot_alerts_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ secret_scanning_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this enterprise. + * transferred to this enterprise. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories: boolean; @@ -13239,15 +21677,15 @@ export interface components { | null; }; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -13262,7 +21700,7 @@ export interface components { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -13272,7 +21710,7 @@ export interface components { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -13286,14 +21724,14 @@ export interface components { readonly vector_string: string | null; }; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -13303,7 +21741,7 @@ export interface components { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -13330,7 +21768,7 @@ export interface components { * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -13338,10 +21776,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -13394,7 +21832,7 @@ export interface components { * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "nullable-alert-updated-at": string | null; + "nullable-alert-updated-at": string | null; /** * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} @@ -13431,10 +21869,8 @@ export interface components { resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -13673,9 +22109,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -13688,9 +22124,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -13789,14 +22225,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -13806,9 +22241,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -13945,11 +22379,9 @@ export interface components { current_user_actor_url?: string; /** @example https://github.com/octocat-org */ current_user_organization_url?: string; - /** - * @example [ - * "https://github.com/organizations/github/octocat.private.atom?token=abc123" - * ] - */ + /** @example [ + * "https://github.com/organizations/github/octocat.private.atom?token=abc123" + * ] */ current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ security_advisories_url?: string; @@ -13996,13 +22428,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -14143,13 +22577,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -14175,15 +22611,17 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; + [key: string]: + | ({ + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + } | null) + | undefined; }; public?: boolean; created_at?: string; @@ -14258,25 +22696,24 @@ export interface components { "gitignore-template": { /** @example C */ name: string; - /** - * @example # Object files - * *.o + /** @example # Object files + * *.o * - * # Libraries - * *.lib - * *.a + * # Libraries + * *.lib + * *.a * - * # Shared objects (inc. Windows DLLs) - * *.dll - * *.so - * *.so.* - * *.dylib + * # Shared objects (inc. Windows DLLs) + * *.dll + * *.so + * *.so.* + * *.dylib * - * # Executables - * *.exe - * *.out - * *.app - */ + * # Executables + * *.exe + * *.out + * *.app + * */ source: string; }; /** @@ -14327,53 +22764,46 @@ export interface components { description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ implementation: string; - /** - * @example [ - * "commercial-use", - * "modifications", - * "distribution", - * "sublicense", - * "private-use" - * ] - */ + /** @example [ + * "commercial-use", + * "modifications", + * "distribution", + * "sublicense", + * "private-use" + * ] */ permissions: string[]; - /** - * @example [ - * "include-copyright" - * ] - */ + /** @example [ + * "include-copyright" + * ] */ conditions: string[]; - /** - * @example [ - * "no-liability" - * ] - */ + /** @example [ + * "no-liability" + * ] */ limitations: string[]; - /** - * @example + /** @example * - * The MIT License (MIT) + * The MIT License (MIT) * - * Copyright (c) [year] [fullname] + * Copyright (c) [year] [fullname] * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * */ body: string; /** @example true */ featured: boolean; @@ -14415,12 +22845,10 @@ export interface components { unit_name: string | null; /** @example published */ state: string; - /** - * @example [ - * "Up to 25 private repositories", - * "11 concurrent builds" - * ] - */ + /** @example [ + * "Up to 25 private repositories", + * "11 concurrent builds" + * ] */ bullets: string[]; }; /** @@ -14465,71 +22893,49 @@ export interface components { SHA256_ECDSA?: string; SHA256_ED25519?: string; }; - /** - * @example [ - * "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" - * ] - */ + /** @example [ + * "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" + * ] */ ssh_keys?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ hooks?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ github_enterprise_importer?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ web?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ api?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ git?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ pages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ importer?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ actions?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ dependabot?: string[]; domains?: { website?: string[]; @@ -14976,47 +23382,47 @@ export interface components { /** * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; @@ -15106,12 +23512,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -15784,9 +24190,9 @@ export interface components { /** * @description List of oauth scopes the token has been granted. * @example [ - * "user", - * "repo" - * ] + * "user", + * "repo" + * ] */ scopes?: string[]; /** @@ -16166,15 +24572,15 @@ export interface components { /** * @description An array of teams linked to this group * @example [ - * { - * "team_id": 1, - * "team_name": "team-test" - * }, - * { - * "team_id": 2, - * "team_name": "team-test2" - * } - * ] + * { + * "team_id": 1, + * "team_name": "team-test" + * }, + * { + * "team_id": 2, + * "team_name": "team-test2" + * } + * ] */ teams: { /** @@ -16191,19 +24597,19 @@ export interface components { /** * @description An array of external members linked to this group * @example [ - * { - * "member_id": 1, - * "member_login": "mona-lisa_eocsaxrs", - * "member_name": "Mona Lisa", - * "member_email": "mona_lisa@github.com" - * }, - * { - * "member_id": 2, - * "member_login": "octo-lisa_eocsaxrs", - * "member_name": "Octo Lisa", - * "member_email": "octo_lisa@github.com" - * } - * ] + * { + * "member_id": 1, + * "member_login": "mona-lisa_eocsaxrs", + * "member_name": "Mona Lisa", + * "member_email": "mona_lisa@github.com" + * }, + * { + * "member_id": 2, + * "member_login": "octo-lisa_eocsaxrs", + * "member_name": "Octo Lisa", + * "member_email": "octo_lisa@github.com" + * } + * ] */ members: { /** @@ -16236,17 +24642,17 @@ export interface components { /** * @description An array of external groups available to be mapped to a team * @example [ - * { - * "group_id": 1, - * "group_name": "group-azuread-test", - * "updated_at": "2021-01-03 22:27:15:000 -700" - * }, - * { - * "group_id": 2, - * "group_name": "group-azuread-test2", - * "updated_at": "2021-06-03 22:27:15:000 -700" - * } - * ] + * { + * "group_id": 1, + * "group_name": "group-azuread-test", + * "updated_at": "2021-01-03 22:27:15:000 -700" + * }, + * { + * "group_id": 2, + * "group_name": "group-azuread-test2", + * "updated_at": "2021-06-03 22:27:15:000 -700" + * } + * ] */ groups?: { /** @@ -16319,12 +24725,10 @@ export interface components { deliveries_url?: string; /** @example web */ name: string; - /** - * @example [ - * "push", - * "pull_request" - * ] - */ + /** @example [ + * "push", + * "pull_request" + * ] */ events: string[]; /** @example true */ active: boolean; @@ -16583,13 +24987,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the request for access was created. */ @@ -16619,13 +25023,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -16718,13 +25122,11 @@ export interface components { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | string[] | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ description?: string | null; - /** - * @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. - */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; /** * @description Who can edit the values of the property @@ -16741,7 +25143,7 @@ export interface components { /** @description The name of the property */ property_name: string; /** @description The value assigned to the property */ - value: string | string[] | null; + value: (string | string[]) | null; }; /** * Organization Repository Custom Property Values @@ -16960,7 +25362,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -16993,7 +25395,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -17005,7 +25407,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -17026,69 +25428,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -17097,14 +25499,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -17311,14 +25713,12 @@ export interface components { open_issues_count: number; /** @example true */ is_template?: boolean; - /** - * @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] - */ + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ topics?: string[]; /** @example true */ has_issues: boolean; @@ -17380,8 +25780,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @example PR_TITLE * @enum {string} */ @@ -17389,9 +25789,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -17399,8 +25799,8 @@ export interface components { /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @example PR_TITLE * @enum {string} */ @@ -17408,9 +25808,9 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -17435,7 +25835,7 @@ export interface components { * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; + anonymous_access_enabled: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ @@ -17453,7 +25853,8 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + * */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -17534,6 +25935,7 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & @@ -17878,7 +26280,7 @@ export interface components { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -17894,7 +26296,7 @@ export interface components { bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** * @description The bypass type of the user making the API request for this ruleset. This field is only returned when - * querying the repository-level endpoint. + * querying the repository-level endpoint. * @enum {string} */ current_user_can_bypass?: "always" | "pull_requests_only" | "never"; @@ -18048,19 +26450,19 @@ export interface components { /** @description A repository security advisory. */ "repository-advisory": { /** @description The GitHub Security Advisory ID. */ - ghsa_id: string; + readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ cve_id: string | null; /** * Format: uri * @description The API URL for the advisory. */ - url: string; + readonly url: string; /** * Format: uri * @description The URL for the advisory. */ - html_url: string; + readonly html_url: string; /** @description A short summary of the advisory. */ summary: string; /** @description A detailed description of what the advisory entails. */ @@ -18071,10 +26473,10 @@ export interface components { */ severity: "critical" | "high" | "medium" | "low" | null; /** @description The author of the advisory. */ - author: components["schemas"]["simple-user"] | null; + readonly author: components["schemas"]["simple-user"] | null; /** @description The publisher of the advisory. */ - publisher: components["schemas"]["simple-user"] | null; - identifiers: readonly { + readonly publisher: components["schemas"]["simple-user"] | null; + readonly identifiers: { /** * @description The type of identifier. * @enum {string} @@ -18092,28 +26494,28 @@ export interface components { * Format: date-time * @description The date and time of when the advisory was created, in ISO 8601 format. */ - created_at: string | null; + readonly created_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - updated_at: string | null; + readonly updated_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. */ - published_at: string | null; + readonly published_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was closed, in ISO 8601 format. */ - closed_at: string | null; + readonly closed_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. */ - withdrawn_at: string | null; - submission: { + readonly withdrawn_at: string | null; + readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; @@ -18124,14 +26526,14 @@ export interface components { /** @description The CVSS vector. */ vector_string: string | null; /** @description The CVSS score. */ - score: number | null; + readonly score: number | null; } | null; - cwes: - | readonly { + readonly cwes: + | { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ - name: string; + readonly name: string; }[] | null; /** @description A list of only the CWE IDs. */ @@ -18143,15 +26545,15 @@ export interface components { type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; - credits_detailed: - | readonly components["schemas"]["repository-advisory-credit"][] + readonly credits_detailed: + | components["schemas"]["repository-advisory-credit"][] | null; /** @description A list of users that collaborate on the advisory. */ collaborating_users: components["schemas"]["simple-user"][] | null; /** @description A list of teams that collaborate on the advisory. */ collaborating_teams: components["schemas"]["team"][] | null; /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ - private_fork: components["schemas"]["simple-repository"] | null; + readonly private_fork: components["schemas"]["simple-repository"] | null; }; /** * Team Simple @@ -18224,17 +26626,17 @@ export interface components { /** * @description Array of groups to be mapped to this team * @example [ - * { - * "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", - * "group_name": "saml-azuread-test", - * "group_description": "A group of Developers working on AzureAD SAML SSO" - * }, - * { - * "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", - * "group_name": "saml-azuread-test2", - * "group_description": "Another group of Developers working on AzureAD SAML SSO" - * } - * ] + * { + * "group_id": "111a1a11-aaa1-1aaa-11a1-a1a1a1a1a1aa", + * "group_name": "saml-azuread-test", + * "group_description": "A group of Developers working on AzureAD SAML SSO" + * }, + * { + * "group_id": "2bb2bb2b-bb22-22bb-2bb2-bb2bbb2bb2b2", + * "group_name": "saml-azuread-test2", + * "group_description": "Another group of Developers working on AzureAD SAML SSO" + * } + * ] */ groups?: { /** @@ -18884,7 +27286,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -18922,7 +27324,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -18943,44 +27345,44 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - allow_forking?: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -19315,10 +27717,10 @@ export interface components { /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ - * "self-hosted", - * "foo", - * "bar" - * ] + * "self-hosted", + * "foo", + * "bar" + * ] */ labels: string[]; /** @@ -19412,9 +27814,9 @@ export interface components { "actions-workflow-access-to-repository": { /** * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the - * repository. + * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. * @enum {string} */ access_level: "none" | "user" | "organization" | "enterprise"; @@ -19786,14 +28188,11 @@ export interface components { * @example deploy */ task: string; - payload: OneOf< - [ - { + payload: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** @example staging */ original_environment?: string; /** @@ -20086,7 +28485,7 @@ export interface components { * @default false * @example true */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; }; /** * Branch Restriction Policy @@ -20233,12 +28632,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -20426,11 +28825,9 @@ export interface components { url: string; /** @example true */ strict: boolean; - /** - * @example [ - * "continuous-integration/travis-ci" - * ] - */ + /** @example [ + * "continuous-integration/travis-ci" + * ] */ contexts: string[]; checks: { /** @example continuous-integration/travis-ci */ @@ -20461,7 +28858,7 @@ export interface components { * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; dismissal_restrictions?: { /** Format: uri */ url: string; @@ -20512,12 +28909,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -20895,12 +29292,12 @@ export interface components { * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; + "code-scanning-analysis-url": string; "code-scanning-analysis": { ref: components["schemas"]["code-scanning-ref"]; commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; @@ -20935,12 +29332,12 @@ export interface components { * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + readonly next_analysis_url: string | null; /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; + readonly confirm_delete_url: string | null; }; /** * CodeQL Database @@ -21037,10 +29434,8 @@ export interface components { | "swift" )[]; }; - /** - * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. - * You should not rely on this always being an actions workflow run object. - */ + /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. + * You should not rely on this always being an actions workflow run object. */ "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ run_id?: number; @@ -21049,7 +29444,7 @@ export interface components { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -21061,7 +29456,7 @@ export interface components { * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; + readonly url?: string; }; "code-scanning-sarifs-status": { /** @@ -21073,9 +29468,9 @@ export interface components { * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** * CODEOWNERS errors @@ -21112,8 +29507,8 @@ export interface components { * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: * - * * user - * ^ + * * user + * ^ */ message: string; /** @@ -22006,10 +30401,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -22149,19 +30544,19 @@ export interface components { name?: string; /** * @description The version of the package. If the package does not have an exact version specified, - * a version range is given. + * a version range is given. * @example 1.0.0 */ versionInfo?: string; /** * @description The location where the package can be downloaded, - * or NOASSERTION if this has not been determined. + * or NOASSERTION if this has not been determined. * @example NOASSERTION */ downloadLocation?: string; /** * @description Whether the package's file content has been subjected to - * analysis during the creation of the SPDX document. + * analysis during the creation of the SPDX document. * @example false */ filesAnalyzed?: boolean; @@ -22172,7 +30567,7 @@ export interface components { licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information - * was not available when the SPDX document was created. + * was not available when the SPDX document was created. * @example NOASSERTION */ licenseDeclared?: string; @@ -22206,7 +30601,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: (string | number | boolean) | null; + [key: string]: ((string | number | boolean) | null) | undefined; }; dependency: { /** @@ -22249,7 +30644,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"]; + [key: string]: components["schemas"]["dependency"] | undefined; }; }; /** @@ -22307,7 +30702,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"]; + [key: string]: components["schemas"]["manifest"] | undefined; }; /** * Format: date-time @@ -22355,7 +30750,7 @@ export interface components { * @default * @example production */ - environment?: string; + environment: string; /** * Format: uri * @description Deprecated: the URL to associate with this status. @@ -22389,14 +30784,14 @@ export interface components { * @default * @example https://staging.example.com/ */ - environment_url?: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - log_url?: string; + log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** @@ -22520,8 +30915,8 @@ export interface components { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -22537,8 +30932,8 @@ export interface components { /** * @description The name pattern that branches must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -22768,43 +31163,43 @@ export interface components { /** * @description Objects specifying a tree structure * @example [ - * { - * "path": "file.rb", - * "mode": "100644", - * "type": "blob", - * "size": 30, - * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" + * { + * "path": "file.rb", + * "mode": "100644", + * "type": "blob", + * "size": 30, + * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", + * "properties": { + * "path": { + * "type": "string" + * }, + * "mode": { + * "type": "string" + * }, + * "type": { + * "type": "string" + * }, + * "size": { + * "type": "integer" + * }, + * "sha": { + * "type": "string" + * }, + * "url": { + * "type": "string" + * } + * }, + * "required": [ + * "path", + * "mode", + * "type", + * "sha", + * "url", + * "size" + * ] * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" * ] - * } - * ] */ tree: { /** @example test/file.rb */ @@ -22851,9 +31246,9 @@ export interface components { /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ - * "push", - * "pull_request" - * ] + * "push", + * "pull_request" + * ] */ events: string[]; config: components["schemas"]["webhook-config"]; @@ -23022,14 +31417,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -23039,9 +31433,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -23843,7 +32236,7 @@ export interface components { * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -23859,7 +32252,7 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} @@ -23985,7 +32378,7 @@ export interface components { * @description Language */ language: { - [key: string]: number; + [key: string]: number | undefined; }; /** * License Content @@ -24125,9 +32518,9 @@ export interface components { /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ - * "example.com", - * "www.example.com" - * ] + * "example.com", + * "www.example.com" + * ] */ domains: string[]; /** Format: date */ @@ -24989,13 +33382,13 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -25190,10 +33583,8 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -25456,7 +33847,7 @@ export interface components { * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - start_private_fork?: boolean; + start_private_fork: boolean; }; "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ @@ -25493,7 +33884,7 @@ export interface components { * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - start_private_fork?: boolean; + start_private_fork: boolean; }; "repository-advisory-update": { /** @description A short summary of the advisory. */ @@ -25563,17 +33954,15 @@ export interface components { * @description Commit Activity */ "commit-activity": { - /** - * @example [ - * 0, - * 3, - * 26, - * 20, - * 39, - * 1, - * 0 - * ] - */ + /** @example [ + * 0, + * 3, + * 26, + * 20, + * 39, + * 1, + * 0 + * ] */ days: number[]; /** @example 89 */ total: number; @@ -25588,16 +33977,14 @@ export interface components { author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ total: number; - /** - * @example [ - * { - * "w": "1367712000", - * "a": 6898, - * "d": 77, - * "c": 10 - * } - * ] - */ + /** @example [ + * { + * "w": "1367712000", + * "a": 6898, + * "d": 77, + * "c": 10 + * } + * ] */ weeks: { w?: number; a?: number; @@ -25745,8 +34132,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: ( | "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -25807,17 +34194,17 @@ export interface components { /** * @description The security group members. * @example [ - * { - * "value": "879db59-3bdf-4490-ad68-ab880a2694745", - * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - * "displayName": "User 1" - * }, - * { - * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - * "displayName": "User 2" - * } - * ] + * { + * "value": "879db59-3bdf-4490-ad68-ab880a2694745", + * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + * "displayName": "User 1" + * }, + * { + * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + * "displayName": "User 2" + * } + * ] */ members?: { value?: string; @@ -25830,8 +34217,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -25856,8 +34243,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:Group"[]; /** @@ -25965,8 +34352,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -26011,8 +34398,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -26077,8 +34464,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -26132,12 +34519,10 @@ export interface components { * @example Jon Doe */ displayName?: string | null; - /** - * @example { - * "givenName": "Jane", - * "familyName": "User" - * } - */ + /** @example { + * "givenName": "Jane", + * "familyName": "User" + * } */ name?: { givenName?: string | null; familyName?: string | null; @@ -26146,15 +34531,15 @@ export interface components { /** * @description user emails * @example [ - * { - * "value": "someone@example.com", - * "primary": true - * }, - * { - * "value": "another@example.com", - * "primary": false - * } - * ] + * { + * "value": "someone@example.com", + * "primary": true + * }, + * { + * "value": "another@example.com", + * "primary": false + * } + * ] */ emails: { value: string; @@ -26190,13 +34575,13 @@ export interface components { /** * @description Set of operations to be performed * @example [ - * { - * "op": "replace", - * "value": { - * "active": false - * } - * } - * ] + * { + * "op": "replace", + * "value": { + * "active": false + * } + * } + * ] */ operations?: { /** @enum {string} */ @@ -26262,12 +34647,10 @@ export interface components { language?: string | null; /** Format: date-time */ last_modified_at?: string; - /** - * @example [ - * "73..77", - * "77..78" - * ] - */ + /** @example [ + * "73..77", + * "77..78" + * ] */ line_numbers?: string[]; text_matches?: components["schemas"]["search-result-text-matches"]; }; @@ -27031,36 +35414,32 @@ export interface components { key_id: string; /** @example xsBNBFayYZ... */ public_key: string; - /** - * @example [ - * { - * "email": "octocat@users.noreply.github.com", - * "verified": true - * } - * ] - */ + /** @example [ + * { + * "email": "octocat@users.noreply.github.com", + * "verified": true + * } + * ] */ emails: { email?: string; verified?: boolean; }[]; - /** - * @example [ - * { - * "id": 4, - * "primary_key_id": 3, - * "key_id": "4A595D4C72EE49C7", - * "public_key": "zsBNBFayYZ...", - * "emails": [], - * "can_sign": false, - * "can_encrypt_comms": true, - * "can_encrypt_storage": true, - * "can_certify": false, - * "created_at": "2016-03-24T11:31:04-06:00", - * "expires_at": null, - * "revoked": false - * } - * ] - */ + /** @example [ + * { + * "id": 4, + * "primary_key_id": 3, + * "key_id": "4A595D4C72EE49C7", + * "public_key": "zsBNBFayYZ...", + * "emails": [], + * "can_sign": false, + * "can_encrypt_comms": true, + * "can_encrypt_storage": true, + * "can_certify": false, + * "created_at": "2016-03-24T11:31:04-06:00", + * "expires_at": null, + * "revoked": false + * } + * ] */ subkeys: { id?: number; primary_key_id?: number; @@ -27203,8 +35582,9 @@ export interface components { /** * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured - * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts)." + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts)." + * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -27252,8 +35632,8 @@ export interface components { /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured - * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * for and sent to a GitHub App. For more information, + * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -27270,7 +35650,7 @@ export interface components { /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an - * organization, or when the event occurs from activity in a repository owned by an organization. + * organization, or when the event occurs from activity in a repository owned by an organization. */ "organization-simple-webhooks": { /** @example github */ @@ -27310,7 +35690,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "repository-webhooks": { /** @@ -27512,7 +35892,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ custom_properties?: { @@ -27548,7 +35928,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -27560,7 +35940,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -27581,7 +35961,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -27691,34 +36071,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -27732,62 +36112,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -27796,14 +36176,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -28383,8 +36763,8 @@ export interface components { repository_url: string; /** * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. * @enum {string} */ state: "open" | "closed" | "locked" | "converting" | "transferring"; @@ -29825,6 +38205,7 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. + * */ "merge-group": { /** @description The SHA of the merge group. */ @@ -29840,7 +38221,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** @@ -30042,7 +38423,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ custom_properties?: { @@ -30078,7 +38459,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -30090,7 +38471,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -30111,7 +38492,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -30221,34 +38602,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -30262,62 +38643,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -30326,14 +38707,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -30475,37 +38856,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ permissions_added: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @@ -30764,41 +39145,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -30806,7 +39187,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; /** Pull Request */ webhooks_pull_request_5: { @@ -31011,24 +39392,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -31064,7 +39445,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -31148,17 +39529,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -31225,7 +39606,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -31233,17 +39614,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -31275,7 +39656,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -31351,24 +39732,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -31404,7 +39785,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -31488,17 +39869,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -31565,7 +39946,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -31573,17 +39954,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -31615,7 +39996,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -31805,9 +40186,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -31842,8 +40222,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -31893,9 +40273,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -34462,7 +42841,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: Record | null; + dismissed_by: Record; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -35563,7 +43942,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -35882,7 +44261,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -36240,7 +44619,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -36570,7 +44949,7 @@ export interface components { id: number; node_id: string; original_environment: string; - payload: string | Record | null; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -37568,24 +45947,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -37625,7 +46004,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -37764,7 +46143,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -37847,7 +46226,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: Record | null; + license?: Record; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -38707,7 +47086,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -38734,10 +47113,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -39296,7 +47675,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -39323,10 +47702,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -39888,7 +48267,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -39915,10 +48294,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -40460,8 +48839,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -40471,13 +48850,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -43904,24 +52283,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -43961,7 +52340,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -44102,7 +52481,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -45592,24 +53971,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -45649,7 +54028,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -45793,7 +54172,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46551,12 +54930,10 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { - /** - * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - * assigned to the collaborator, use the `role_name` field instead, which will provide the full - * role name, including custom roles. - */ + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; @@ -47035,11 +55412,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string; + [key: string]: string | undefined; }; repo?: string; dependencies?: { - [key: string]: string; + [key: string]: string | undefined; }[]; commit_oid?: string; }; @@ -47139,8 +55516,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -47165,19 +55542,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: Record | null; - bugs?: Record | null; + author?: Record; + bugs?: Record; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: Record | null; + dist?: Record; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: Record | null; + repository?: Record; scripts?: Record; id?: string; node_version?: string; @@ -47190,7 +55567,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: Record | null; + directories?: Record; os?: string[]; cpu?: string[]; readme?: string; @@ -47204,19 +55581,16 @@ export interface components { | { id?: number | string; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -48093,22 +56467,19 @@ export interface components { "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; - changes?: OneOf< - [ - { + changes?: + | { field_value: { field_node_id?: string; field_type?: string; }; - }, - { + } + | { body: { from?: string | null; to?: string | null; }; - }, - ] - >; + }; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; @@ -48368,24 +56739,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48421,7 +56792,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48505,17 +56876,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48582,7 +56953,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48590,9 +56961,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48602,8 +56973,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48635,7 +57006,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48711,24 +57082,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48764,7 +57135,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48848,17 +57219,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48925,7 +57296,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48933,9 +57304,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48945,8 +57316,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48978,7 +57349,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -49168,9 +57539,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49205,8 +57575,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -49256,9 +57626,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -49580,24 +57949,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -49633,7 +58002,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49717,17 +58086,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49794,7 +58163,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49802,9 +58171,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -49814,8 +58183,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49847,7 +58216,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -49923,24 +58292,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -49976,7 +58345,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50060,17 +58429,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50137,7 +58506,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50145,9 +58514,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50157,8 +58526,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50190,7 +58559,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50380,9 +58749,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50417,8 +58785,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -50468,9 +58836,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -50793,24 +59160,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50846,7 +59213,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50930,17 +59297,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51007,7 +59374,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51015,9 +59382,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51027,8 +59394,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51060,7 +59427,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51136,24 +59503,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51189,7 +59556,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51273,17 +59640,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51350,7 +59717,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51358,9 +59725,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51370,8 +59737,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51403,7 +59770,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51593,9 +59960,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51630,8 +59996,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -51681,9 +60047,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -52042,24 +60407,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52095,7 +60460,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52179,17 +60544,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52256,7 +60621,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52264,9 +60629,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52276,8 +60641,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52309,7 +60674,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52385,24 +60750,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52438,7 +60803,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52522,17 +60887,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52599,7 +60964,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52607,9 +60972,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52619,8 +60984,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52652,7 +61017,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52842,9 +61207,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52879,8 +61243,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -52930,9 +61294,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -53286,24 +61649,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53339,7 +61702,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53423,17 +61786,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53500,7 +61863,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53508,9 +61871,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53520,8 +61883,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53553,7 +61916,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53629,24 +61992,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53682,7 +62045,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53766,17 +62129,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53843,7 +62206,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53851,9 +62214,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53863,8 +62226,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53896,7 +62259,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54086,9 +62449,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54123,8 +62485,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -54174,9 +62536,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -54499,24 +62860,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54552,7 +62913,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54636,17 +62997,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -54713,7 +63074,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54721,9 +63082,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -54733,8 +63094,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -54766,7 +63127,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54842,24 +63203,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54895,7 +63256,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54979,17 +63340,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -55056,7 +63417,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55064,9 +63425,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -55076,8 +63437,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -55109,7 +63470,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -55299,9 +63660,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55336,8 +63696,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -55387,9 +63747,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -55711,24 +64070,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55764,7 +64123,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55848,17 +64207,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -55925,7 +64284,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55933,9 +64292,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -55945,8 +64304,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -55978,7 +64337,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56054,24 +64413,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56107,7 +64466,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56191,17 +64550,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56268,7 +64627,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56276,9 +64635,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -56288,8 +64647,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -56321,7 +64680,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56511,9 +64870,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56548,8 +64906,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -56599,9 +64957,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -57121,24 +65478,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57174,7 +65531,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57258,17 +65615,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57335,7 +65692,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57343,9 +65700,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57355,8 +65712,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57388,7 +65745,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57457,24 +65814,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57510,7 +65867,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57559,7 +65916,7 @@ export interface components { * @description Whether discussions are enabled. * @default false */ - has_discussions?: boolean; + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -57594,17 +65951,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57671,7 +66028,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57679,9 +66036,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57691,8 +66048,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57724,7 +66081,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57869,9 +66226,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57906,8 +66262,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -57957,9 +66313,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -58273,24 +66628,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58326,7 +66681,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58410,17 +66765,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58487,7 +66842,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58495,9 +66850,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58507,8 +66862,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58540,7 +66895,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58609,24 +66964,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58662,7 +67017,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58746,17 +67101,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58823,7 +67178,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58831,9 +67186,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58843,8 +67198,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58876,7 +67231,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59021,9 +67376,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -59058,8 +67412,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -59109,9 +67463,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -59426,24 +67779,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59479,7 +67832,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59563,17 +67916,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59640,7 +67993,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59648,9 +68001,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59660,8 +68013,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -59693,7 +68046,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59762,24 +68115,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59815,7 +68168,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59899,17 +68252,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59976,7 +68329,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59984,9 +68337,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59996,8 +68349,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60029,7 +68382,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60174,9 +68527,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -60211,8 +68563,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -60262,9 +68614,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -60578,24 +68929,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60631,7 +68982,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60715,17 +69066,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60792,7 +69143,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60800,9 +69151,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60812,8 +69163,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60845,7 +69196,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60914,24 +69265,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60967,7 +69318,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61051,17 +69402,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -61128,7 +69479,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61136,9 +69487,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -61148,8 +69499,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -61181,7 +69532,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61326,9 +69677,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -61363,8 +69713,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -61414,9 +69764,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -61817,24 +70166,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61870,7 +70219,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62009,7 +70358,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62104,24 +70453,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62157,7 +70506,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62296,7 +70645,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62467,9 +70816,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -62504,8 +70852,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -62555,9 +70903,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -62664,9 +71011,8 @@ export interface components { sender: components["schemas"]["simple-user-webhooks"]; }; /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": OneOf< - [ - { + "webhook-pull-request-review-request-removed": + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -62877,24 +71223,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62930,7 +71276,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63014,17 +71360,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -63091,7 +71437,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63137,7 +71483,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -63213,24 +71559,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63266,7 +71612,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63350,17 +71696,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -63427,7 +71773,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63435,9 +71781,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -63447,8 +71793,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -63480,7 +71826,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -63670,9 +72016,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -63707,8 +72052,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -63758,9 +72103,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -63907,8 +72251,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -64119,24 +72463,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64172,7 +72516,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64256,17 +72600,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -64333,7 +72677,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64341,9 +72685,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64353,8 +72697,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64386,7 +72730,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -64462,24 +72806,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64515,7 +72859,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64599,17 +72943,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -64676,7 +73020,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64684,9 +73028,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64696,8 +73040,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64729,7 +73073,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -64919,9 +73263,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -64956,8 +73299,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -65007,9 +73350,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -65174,13 +73516,10 @@ export interface components { url: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request review_requested event */ - "webhook-pull-request-review-requested": OneOf< - [ - { + "webhook-pull-request-review-requested": + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -65391,24 +73730,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65444,7 +73783,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65528,17 +73867,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65605,7 +73944,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65613,9 +73952,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65625,8 +73964,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65658,7 +73997,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65734,24 +74073,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65787,7 +74126,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65871,17 +74210,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65948,7 +74287,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65956,9 +74295,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65968,8 +74307,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66001,7 +74340,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66191,9 +74530,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -66228,8 +74566,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -66279,9 +74617,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -66428,8 +74765,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -66640,24 +74977,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66693,7 +75030,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66777,17 +75114,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66854,7 +75191,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66862,9 +75199,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66874,8 +75211,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66907,7 +75244,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66983,24 +75320,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67036,7 +75373,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67120,17 +75457,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -67197,7 +75534,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67205,9 +75542,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67217,8 +75554,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -67250,7 +75587,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67440,9 +75777,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -67477,8 +75813,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -67528,9 +75864,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -67695,9 +76030,7 @@ export interface components { url?: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { /** @enum {string} */ @@ -67907,24 +76240,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67960,7 +76293,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68044,17 +76377,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -68121,7 +76454,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68129,9 +76462,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -68141,8 +76474,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -68174,7 +76507,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68243,24 +76576,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68296,7 +76629,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68380,17 +76713,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -68457,7 +76790,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68465,9 +76798,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -68477,8 +76810,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -68510,7 +76843,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68655,9 +76988,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -68692,8 +77024,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -68743,9 +77075,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -69060,24 +77391,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69113,7 +77444,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -69257,7 +77588,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69354,24 +77685,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69407,7 +77738,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -69551,7 +77882,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69724,9 +78055,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -69761,8 +78091,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -69812,9 +78142,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -70280,24 +78609,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70333,7 +78662,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70477,7 +78806,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -70574,24 +78903,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70627,7 +78956,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70771,7 +79100,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -70944,9 +79273,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -70981,8 +79309,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -71032,9 +79360,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -71504,24 +79831,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71557,7 +79884,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71641,17 +79968,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -71718,7 +80045,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71726,9 +80053,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -71738,8 +80065,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -71771,7 +80098,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -71847,24 +80174,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71900,7 +80227,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72054,7 +80381,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -72062,9 +80389,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -72074,8 +80401,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -72107,7 +80434,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -72297,9 +80624,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -72334,8 +80660,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -72385,9 +80711,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -72710,24 +81035,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -72763,7 +81088,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72847,17 +81172,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -72924,7 +81249,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -72932,9 +81257,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -72944,8 +81269,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -72977,7 +81302,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -73053,24 +81378,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -73106,7 +81431,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -73190,17 +81515,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -73267,7 +81592,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -73275,9 +81600,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -73287,8 +81612,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -73320,7 +81645,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -73510,9 +81835,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -73547,8 +81871,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -73598,9 +81922,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -73923,24 +82246,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -73976,7 +82299,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -74060,17 +82383,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -74137,7 +82460,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -74145,9 +82468,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -74157,8 +82480,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -74190,7 +82513,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -74266,24 +82589,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -74319,7 +82642,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -74473,7 +82796,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -74481,9 +82804,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -74493,8 +82816,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -74526,7 +82849,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -74716,9 +83039,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -74753,8 +83075,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -74804,9 +83126,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -75128,24 +83449,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -75181,7 +83502,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -75265,17 +83586,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -75342,7 +83663,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -75350,9 +83671,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -75362,8 +83683,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -75395,7 +83716,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -75471,24 +83792,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -75524,7 +83845,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -75608,17 +83929,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -75685,7 +84006,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -75693,9 +84014,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -75705,8 +84026,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -75738,7 +84059,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -75928,9 +84249,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -75965,8 +84285,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -76016,9 +84336,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -76273,24 +84592,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -76330,7 +84649,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -76474,7 +84793,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -76571,8 +84890,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -76596,19 +84915,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: string | Record | null; - bugs?: string | Record | null; + author?: (string | Record) | null; + bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: string | Record | null; + dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: string | Record | null; + repository?: (string | Record) | null; scripts?: Record; id?: string; node_version?: string; @@ -76621,7 +84940,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: string | Record | null; + directories?: (string | Record) | null; os?: string[]; cpu?: string[]; readme?: string; @@ -76633,21 +84952,18 @@ export interface components { } | null; nuget_metadata?: | { - id?: string | Record | number | null; + id?: (string | Record | number) | null; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -76844,7 +85160,7 @@ export interface components { updated_at: string; version: string; }; - registry: Record | null; + registry: Record; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -78028,24 +86344,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -78085,7 +86401,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -78224,7 +86540,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -78277,24 +86593,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -78334,7 +86650,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -78473,7 +86789,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -78526,24 +86842,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -78583,7 +86899,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -78722,7 +87038,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -78806,24 +87122,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -78863,7 +87179,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -79002,7 +87318,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -79055,24 +87371,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -79112,7 +87428,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -79251,7 +87567,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -79411,7 +87727,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: (Record | null)[]; + steps?: Record[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -81032,18 +89348,27 @@ export interface components { responses: { /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Resource not found */ not_found: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad Request */ bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -81051,34 +89376,52 @@ export interface components { }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ accepted: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description Not modified */ not_modified: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Requires authentication */ requires_authentication: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response */ actions_runner_jitconfig: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { runner: components["schemas"]["runner"]; @@ -81089,6 +89432,9 @@ export interface components { }; /** @description Response */ actions_runner_labels: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81098,6 +89444,9 @@ export interface components { }; /** @description Response */ actions_runner_labels_readonly: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81107,6 +89456,9 @@ export interface components { }; /** @description Service unavailable */ service_unavailable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -81117,12 +89469,18 @@ export interface components { }; /** @description Internal Error */ internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden Gist */ forbidden_gist: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { block?: { @@ -81137,78 +89495,120 @@ export interface components { }; /** @description Moved permanently */ moved_permanently: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Conflict */ conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description A header with no content is returned. */ no_content: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Gone */ gone: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Temporary Redirect */ temporary_redirect: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Found */ found: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if there is already a validation run in progress with a different default setup configuration */ code_scanning_conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ dependency_review_forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unavailable due to service under maintenance. */ porter_maintenance: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unacceptable */ unacceptable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad request */ scim_bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -81216,14 +89616,23 @@ export interface components { }; /** @description Authorization failure */ authorization_failure: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Permission denied */ permission_denied: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Too many requests */ scim_too_many_requests: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -81231,6 +89640,9 @@ export interface components { }; /** @description Internal server error */ scim_internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -81238,10 +89650,16 @@ export interface components { }; /** @description Duplicate record detected */ duplicate_record_detected: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Resource not found */ scim_not_found: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -81249,6 +89667,9 @@ export interface components { }; /** @description Forbidden */ scim_forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -81256,6 +89677,9 @@ export interface components { }; /** @description Conflict */ scim_conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -81264,22 +89688,22 @@ export interface components { }; parameters: { /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; + "pagination-before": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; + "pagination-after": string; /** @description The direction to sort the results by. */ - direction?: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: string; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "per-page"?: number; + "per-page": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: string; + cursor: string; "delivery-id": number; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: number; + page: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: string; + since: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The client ID of the GitHub app. */ @@ -81296,7 +89720,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization"?: string; + "visible-to-organization": string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -81304,85 +89728,67 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase"?: string; - /** - * @description The event types to include: + "audit-log-enterprise-phrase": string; + /** @description The event types to include: * - * - `web` - returns web (non-Git) events. - * - `git` - returns Git events. - * - `all` - returns both web and Git events. + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. * - * The default is `web`. - */ - "audit-log-include"?: "web" | "git" | "all"; + * The default is `web`. */ + "audit-log-include": "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after"?: string; + "audit-log-after": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before"?: string; - /** - * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + "audit-log-before": string; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * - * The default is `desc`. - */ - "audit-log-order"?: "desc" | "asc"; + * The default is `desc`. */ + "audit-log-order": "desc" | "asc"; /** @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. */ - "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @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. */ - "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - "dependabot-alert-comma-separated-states"?: string; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ + "dependabot-alert-comma-separated-states": string; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * - * Can be: `low`, `medium`, `high`, `critical` - */ - "dependabot-alert-comma-separated-severities"?: string; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * Can be: `low`, `medium`, `high`, `critical` */ + "dependabot-alert-comma-separated-severities": string; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - "dependabot-alert-comma-separated-ecosystems"?: string; + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ + "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages"?: string; + "dependabot-alert-comma-separated-packages": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope"?: "development" | "runtime"; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - */ - "dependabot-alert-sort"?: "created" | "updated"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first"?: number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last"?: number; + "dependabot-alert-scope": "development" | "runtime"; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ + "dependabot-alert-sort": "created" | "updated"; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ + "pagination-first": number; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ + "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ - "secret-scanning-alert-secret-type"?: string; + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution"?: string; + "secret-scanning-alert-resolution": string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort"?: "created" | "updated"; + "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ - "secret-scanning-alert-validity"?: string; + "secret-scanning-alert-validity": string; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" @@ -81390,53 +89796,51 @@ export interface components { | "dependabot_alerts" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the enterprise. - * `disable_all` means to disable the specified security feature for all repositories in the enterprise. - */ + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ "enterprise-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: string; + labels: string; /** @description account_id parameter */ "account-id": number; /** @description The unique identifier of the plan. */ "plan-id": number; /** @description The property to sort the results by. */ - sort?: "created" | "updated"; + sort: "created" | "updated"; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all?: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: string; + before: string; /** @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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org"?: number; + "since-org": number; /** @description The organization name. The name is not case sensitive. */ org: string; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository"?: string; + "visible-to-repository": string; /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "variables-per-page"?: number; + "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase"?: string; + "audit-log-phrase": string; /** @description The handle for the GitHub user account. */ username: string; /** @description The unique identifier of the role. */ @@ -81455,13 +89859,11 @@ export interface components { "repo-name": string; /** @description The slug of the team name. */ "team-slug": string; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - */ - "package-visibility"?: "public" | "private" | "internal"; + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ + "package-visibility": "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ "package-type": | "npm" @@ -81475,44 +89877,40 @@ export interface components { /** @description Unique identifier of the package version. */ "package-version-id": number; /** @description The property by which to sort the results. */ - "personal-access-token-sort"?: "created_at"; + "personal-access-token-sort": "created_at"; /** @description A list of owner usernames to use to filter the results. */ - "personal-access-token-owner"?: string[]; + "personal-access-token-owner": string[]; /** @description The name of the repository to use to filter the results. */ - "personal-access-token-repository"?: string; + "personal-access-token-repository": string; /** @description The permission to use to filter the results. */ - "personal-access-token-permission"?: string; + "personal-access-token-permission": string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-before"?: string; + "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-after"?: string; + "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query"?: number; - /** - * @description The time period to filter by. + "repository-name-in-query": number; + /** @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). - */ - "time-period"?: "hour" | "day" | "week" | "month"; + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ + "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - "actor-name-in-query"?: string; + "actor-name-in-query": string; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - "rule-suite-result"?: "pass" | "fail" | "bypass" | "all"; - /** - * @description The unique identifier of the rule suite result. - * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites) - * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites) - * for organizations. - */ + "rule-suite-result": "pass" | "fail" | "bypass" | "all"; + /** @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. */ "rule-suite-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo"?: string; + "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo"?: string; + "secret-scanning-pagination-after-org-repo": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -81530,27 +89928,25 @@ export interface components { | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the card. */ "card-id": number; /** @description The unique identifier of the column. */ "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - "artifact-name"?: string; + "artifact-name": string; /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full"?: string; + "actions-cache-git-ref-full": string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key"?: string; + "actions-cache-key": string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort"?: + "actions-cache-list-sort": | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -81561,13 +89957,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch"?: string; + "workflow-run-branch": string; /** @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/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: string; + event: string; /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ - "workflow-run-status"?: + "workflow-run-status": | "completed" | "action_required" | "cancelled" @@ -81583,13 +89979,13 @@ export interface components { | "waiting" | "pending"; /** @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/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests"?: boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id"?: number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha"?: string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -81605,11 +90001,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name"?: string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - status?: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @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`. */ - "git-ref"?: components["schemas"]["code-scanning-ref"]; + "git-ref": components["schemas"]["code-scanning-ref"]; /** @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. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -81617,16 +90013,14 @@ export interface components { /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ "commit-ref": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests"?: string; - /** - * @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. - */ + "dependabot-alert-comma-separated-manifests": string; + /** @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. */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path"?: string; + "manifest-path": string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ @@ -81641,7 +90035,7 @@ export interface components { */ "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user"?: number; + "since-user": number; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -81659,41 +90053,41 @@ export interface components { /** @description The unique identifier of the release. */ "release-id": number; /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ - "ref-in-query"?: string; + "ref-in-query": string; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ - per?: "day" | "week"; + per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo"?: number; + "since-repo": number; /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ - "excluded-attributes"?: string; + "excluded-attributes": string; /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ - "start-index"?: number; + "start-index": number; /** @description Used for pagination: the number of results to return per page. */ - count?: number; + count: number; /** @description A unique identifier of the SCIM group. */ "scim-group-id": string; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: "desc" | "asc"; + order: "desc" | "asc"; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ - "repository-id-in-query"?: number; + "repository-id-in-query": number; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ "export-id": string; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "since-repo-date"?: string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date"?: string; + "before-repo-date": string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred"?: "created" | "updated"; + "sort-starred": "created" | "updated"; }; requestBodies: never; headers: { @@ -81714,32 +90108,28 @@ export interface components { }; pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - /** - * GitHub API Root - * @description Get Hypermedia links to resources accessible in GitHub's REST API - */ "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["root"]; }; }; }; }; - /** - * List global security advisories - * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. - * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." - */ "security-advisories/list-global-advisories": { parameters: { query?: { @@ -81753,51 +90143,51 @@ export interface operations { ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ severity?: "unknown" | "low" | "medium" | "high" | "critical"; - /** - * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. * - * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` - */ + * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` */ cwes?: string | string[]; /** @description Whether to only return advisories that have been withdrawn. */ is_withdrawn?: boolean; - /** - * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. - * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + /** @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` - */ + * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ affects?: string | string[]; - /** - * @description If specified, only return advisories that were published on a date or date range. + /** @description If specified, only return advisories that were published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ published?: string; - /** - * @description If specified, only return advisories that were updated on a date or date range. + /** @description If specified, only return advisories that were updated on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ updated?: string; - /** - * @description If specified, only show advisories that were updated or published on a date or date range. + /** @description If specified, only show advisories that were updated or published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description The property to sort the results by. */ sort?: "updated" | "published"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-advisory"][]; }; @@ -81805,25 +90195,32 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; /** @description Too many requests */ 429: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get a global security advisory - * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. - */ "security-advisories/get-global-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-advisory"]; }; @@ -81831,35 +90228,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; }; }; }; - /** - * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ "apps/create-from-manifest": { parameters: { + query?: never; + header?: never; path: { code: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"] & { client_id: string; @@ -81874,29 +90278,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a webhook configuration for an app - * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an app - * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -81910,29 +90318,35 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an app webhook - * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -81941,21 +90355,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for an app webhook - * @description Returns a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -81964,38 +90379,41 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an app webhook - * @description Redeliver a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List installation requests for the authenticated app - * @description Lists all the pending installation requests for the authenticated GitHub App. - */ "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of integration installation requests */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration-installation-request"][]; }; @@ -82004,26 +90422,28 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List installations for the authenticated app - * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * The permissions the installation has are included under the `permissions` key. - */ "apps/list-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; outdated?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description The permissions the installation has are included under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -82171,11 +90591,11 @@ export interface operations { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ permissions: { /** @@ -82358,12 +90778,10 @@ export interface operations { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -82445,21 +90863,23 @@ export interface operations { }; }; }; - /** - * Get an installation for the authenticated app - * @description Enables an authenticated GitHub App to find an installation's information using the installation id. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -82467,43 +90887,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#suspend-an-app-installation)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/delete-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. - * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. - * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/create-installation-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82513,8 +90927,8 @@ export interface operations { /** * @description List of repository IDs that the token should have access to * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -82524,6 +90938,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation-token"]; }; @@ -82534,56 +90951,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Cloud API or webhook events is blocked for that account. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/suspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unsuspend an app installation - * @description Removes a GitHub App installation suspension. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/unsuspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "apps/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82596,20 +91016,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. - */ "apps/check-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82622,6 +91045,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -82630,15 +91056,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. - */ "apps/delete-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82651,20 +91077,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ "apps/reset-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82677,6 +91106,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -82684,23 +91116,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a scoped access token - * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. - * - * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. - */ "apps/scope-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82725,8 +91149,8 @@ export interface operations { /** * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -82736,6 +91160,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -82746,19 +91173,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - */ "apps/get-by-slug": { parameters: { + query?: never; + header?: never; path: { app_slug: components["parameters"]["app-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; @@ -82767,19 +91197,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get an assignment - * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. - */ "classroom/get-an-assignment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the classroom assignment. */ assignment_id: components["parameters"]["assignment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom-assignment"]; }; @@ -82787,42 +91221,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List accepted assignments for an assignment - * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. - */ "classroom/list-accepted-assigments-for-an-assignment": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The unique identifier of the classroom assignment. */ assignment_id: components["parameters"]["assignment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom-accepted-assignment"][]; }; }; }; }; - /** - * Get assignment grades - * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. - */ "classroom/get-assignment-grades": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the classroom assignment. */ assignment_id: components["parameters"]["assignment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom-assignment-grade"][]; }; @@ -82830,39 +91273,48 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List classrooms - * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. - */ "classroom/list-classrooms": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-classroom"][]; }; }; }; }; - /** - * Get a classroom - * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. - */ "classroom/get-a-classroom": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the classroom. */ classroom_id: components["parameters"]["classroom-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom"]; }; @@ -82870,37 +91322,48 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List assignments for a classroom - * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. - */ "classroom/list-assignments-for-a-classroom": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The unique identifier of the classroom. */ classroom_id: components["parameters"]["classroom-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-classroom-assignment"][]; }; }; }; }; - /** - * Get all codes of conduct - * @description Returns array of all GitHub's codes of conduct. - */ "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"][]; }; @@ -82908,19 +91371,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a code of conduct - * @description Returns information about the specified GitHub code of conduct. - */ "codes-of-conduct/get-conduct-code": { parameters: { + query?: never; + header?: never; path: { key: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"]; }; @@ -82929,33 +91395,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get emojis - * @description Lists all the emojis available to use on GitHub Enterprise Cloud. - */ "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { - [key: string]: string; + [key: string]: string | undefined; }; }; }; 304: components["responses"]["not_modified"]; }; }; - /** - * Get GitHub Enterprise Server statistics - * @description 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. - * - * OAuth app tokens and personal access tokens (classic) need: - * - the `read:enterprise` scope if you connected your GitHub Enterprise Server to an enterprise account and enabled Server Statistics - * - the `read:org` scope if you connected your GitHub Enterprise Server to an organization account and enabled Server Statistics - */ "enterprise-admin/get-server-statistics": { parameters: { query?: { @@ -82964,37 +91426,43 @@ export interface operations { /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ date_end?: string; }; + header?: never; path: { + /** @description The slug version of the enterprise name or the login of an organization. */ enterprise_or_org: components["parameters"]["enterprise-or-org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["server-statistics"]; }; }; }; }; - /** - * Get GitHub Actions cache usage for an enterprise - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -83002,17 +91470,15 @@ export interface operations { }; }; }; - /** - * Set the GitHub Actions OIDC custom issuer policy for an enterprise - * @description Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-actions-oidc-custom-issuer-policy-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83022,42 +91488,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Actions permissions for an enterprise - * @description Gets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-enterprise-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an enterprise - * @description Sets the GitHub Actions permissions policy for organizations and allowed actions and reusable workflows in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83070,29 +91539,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -83102,17 +91577,15 @@ export interface operations { }; }; }; - /** - * Set selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83125,82 +91598,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected organization for GitHub Actions in an enterprise - * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/enable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected organization for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/disable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions and reusable workflows for an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions and reusable workflows for an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83210,46 +91692,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an enterprise - * @description 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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an enterprise - * @description 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83259,30 +91740,37 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an enterprise - * @description Lists all self-hosted runner groups for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this organization. */ visible_to_organization?: components["parameters"]["visible-to-organization"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -83292,17 +91780,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an enterprise - * @description Creates a new self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83336,66 +91822,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Get a self-hosted runner group for an enterprise - * @description Gets a specific self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an enterprise - * @description Deletes a self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an enterprise - * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83426,32 +91920,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * List organization access to a self-hosted runner group in an enterprise - * @description Lists the organizations with access to a self-hosted runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -83461,18 +91962,17 @@ export interface operations { }; }; }; - /** - * Set organization access for a self-hosted runner group in an enterprise - * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -83485,74 +91985,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add organization access to a self-hosted runner group in an enterprise - * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove organization access to a self-hosted runner group in an enterprise - * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an enterprise - * @description Lists the self-hosted runners that are in a specific enterprise group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -83563,18 +92076,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an enterprise - * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -83587,75 +92099,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an enterprise - * @description Adds a self-hosted runner to a runner group configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an enterprise - * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an enterprise - * @description Lists all self-hosted runners configured for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -83666,38 +92190,38 @@ export interface operations { }; }; }; - /** - * List runner applications for an enterprise - * @description Lists binaries for the runner application that you can download and run. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for an Enterprise - * @description Generates a configuration that can be passed to the runner application at startup. - * - * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83722,138 +92246,129 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for an enterprise - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. - * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-registration-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an enterprise - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. - * - * Example using remove token: - * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-remove-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an enterprise - * @description Gets a specific self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an enterprise - * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an enterprise - * @description Lists all labels for a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an enterprise - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -83869,18 +92384,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an enterprise - * @description Add custom labels to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -83896,95 +92410,99 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an enterprise - * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an enterprise - * @description 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. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get announcement banner for enterprise - * @description Gets the announcement banner currently set for the enterprise. - */ "announcement-banners/get-announcement-banner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Remove announcement banner from enterprise - * @description Removes the announcement banner currently set for the enterprise. - */ "announcement-banners/remove-announcement-banner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set announcement banner for enterprise - * @description Sets the announcement banner to display for the enterprise. - */ "announcement-banners/set-announcement-banner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -83994,78 +92512,97 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Get the audit log for an enterprise - * @description Gets the audit log for an enterprise. - * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." - * - * The authenticated user must be an enterprise admin to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. - */ "enterprise-admin/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-enterprise-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an enterprise - * @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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. - */ "code-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -84075,23 +92612,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get code security and analysis features for an enterprise - * @description Gets code security and analysis settings for the specified enterprise. - * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/get-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-security-analysis-settings"]; }; @@ -84099,19 +92636,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update code security and analysis features for an enterprise - * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/patch-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84126,10 +92659,8 @@ export interface operations { secret_scanning_enabled_for_new_repositories?: boolean; /** @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/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; - /** - * @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/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." - * To disable this functionality, set this field to `null`. - */ + /** @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/enterprise-cloud@latest//code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; /** @description Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this enterprise. */ secret_scanning_validity_checks_enabled?: boolean | null; @@ -84139,38 +92670,43 @@ export interface operations { responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List enterprise consumed licenses - * @description Lists the license consumption information for all users, including those from connected servers, associated with an enterprise. - * - * The authenticated user must be an enterprise admin to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-consumed-licenses": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Consumed Licenses Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["get-consumed-licenses"]; @@ -84178,23 +92714,6 @@ export interface operations { }; }; }; - /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. - */ "copilot/usage-metrics-for-enterprise": { parameters: { query?: { @@ -84202,17 +92721,25 @@ export interface operations { since?: string; /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-usage-metrics"][]; }; @@ -84223,39 +92750,60 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. - */ "dependabot/list-alerts-for-enterprise": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -84266,56 +92814,67 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a license sync status - * @description Gets information about the status of a license sync job for an enterprise. - * - * The authenticated user must be an enterprise admin to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-license-sync-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description License Sync Status Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["get-license-sync-status"]; }; }; }; }; - /** - * List secret scanning alerts for an enterprise - * @description 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for repositories owned by enterprise managed users. - */ "secret-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -84325,144 +92884,158 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get GitHub Actions billing for an enterprise - * @description Gets the summary of the free and paid GitHub Actions minutes used. - * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage 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/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * The authenticated user must be an enterprise admin. - */ "billing/get-github-actions-billing-ghe": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-billing-usage"]; }; }; }; }; - /** - * Get GitHub Advanced Security active committers for an enterprise - * @description 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. - */ "billing/get-github-advanced-security-billing-ghe": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; }; }; - /** - * Get GitHub Packages billing for an enterprise - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * The authenticated user must be an enterprise admin. - */ "billing/get-github-packages-billing-ghe": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["packages-billing-usage"]; }; }; }; }; - /** - * Get shared storage billing for an enterprise - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * The authenticated user must be an enterprise admin. - */ "billing/get-shared-storage-billing-ghe": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-billing-usage"]; }; }; }; }; - /** - * Enable or disable a security feature - * @description Enables or disables the specified security feature for all repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/post-security-product-enablement-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["enterprise-security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ enablement: components["parameters"]["enterprise-security-product-enablement"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. - */ "activity/list-public-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -84472,49 +93045,47 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get feeds - * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. - * - * * **Timeline**: The GitHub Enterprise Cloud global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Cloud. - * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. - */ "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["feed"]; }; }; }; }; - /** - * List gists for the authenticated user - * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: - */ "gists/list": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -84524,13 +93095,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a gist - * @description Allows you to add a new gist with one or more files. - * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - */ "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -84542,16 +93113,18 @@ export interface operations { /** * @description Names and content for the files that make up the gist * @example { - * "hello.rb": { - * "content": "puts \"Hello, World!\"" - * } - * } + * "hello.rb": { + * "content": "puts \"Hello, World!\"" + * } + * } */ files: { - [key: string]: { - /** @description Content of the file */ - content: string; - }; + [key: string]: + | { + /** @description Content of the file */ + content: string; + } + | undefined; }; public?: boolean | ("true" | "false"); }; @@ -84563,6 +93136,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"]; @@ -84574,25 +93148,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List public gists - * @description List public gists sorted by most recently updated to least recently updated. - * - * Note: With [pagination](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - */ "gists/list-public": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -84603,23 +93179,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List starred gists - * @description List the authenticated user's starred gists: - */ "gists/list-starred": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -84630,24 +93210,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a gist - * @description Gets a specified gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -84657,32 +93236,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist */ "gists/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist - * @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. - */ "gists/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84694,23 +93280,25 @@ export interface operations { description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. + * (including extension) of the targeted gist file. For example: `hello.py`. * - * To delete a file, set the whole file to null. For example: `hello.py : null`. + * To delete a file, set the whole file to null. For example: `hello.py : null`. * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } */ files?: { - [key: string]: { - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - }; + [key: string]: + | { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + } + | undefined; }; } | null; }; @@ -84718,6 +93306,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -84726,30 +93317,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List gist comments - * @description Lists the comments on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/list-comments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"][]; @@ -84760,20 +93349,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a gist comment - * @description Creates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84792,6 +93376,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"]; @@ -84802,25 +93387,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist comment - * @description Gets a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -84830,39 +93415,43 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist comment */ "gists/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist comment - * @description Updates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84878,6 +93467,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -84885,23 +93477,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist commits */ "gists/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-commit"][]; @@ -84912,22 +93510,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist forks */ "gists/list-forks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"][]; @@ -84938,19 +93542,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Fork a gist */ "gists/fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"]; @@ -84962,84 +93571,104 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Check if a gist is starred */ "gists/check-is-starred": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if gist is starred */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; }; }; - /** - * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - */ "gists/star": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** Unstar a gist */ "gists/unstar": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist revision - * @description Gets a specified gist revision. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-revision": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -85049,14 +93678,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-for-the-authenticated-user). - */ "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -85064,23 +93699,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a gitignore template - * @description Get the content of a gitignore template. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. - */ "gitignore/get-template": { parameters: { + query?: never; + header?: never; path: { name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gitignore-template"]; }; @@ -85088,22 +93722,25 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * List repositories accessible to the app installation - * @description List repositories that an app installation can access. - */ "apps/list-repos-accessible-to-installation": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85119,38 +93756,24 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Revoke an installation access token - * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. - * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - */ "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List issues assigned to the authenticated user - * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list": { parameters: { query?: { @@ -85164,24 +93787,34 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; collab?: boolean; orgs?: boolean; owned?: boolean; pulls?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -85192,21 +93825,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get-all-commonly-used": { parameters: { query?: { featured?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-simple"][]; }; @@ -85214,19 +93852,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get": { parameters: { + query?: never; + header?: never; path: { license: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license"]; }; @@ -85236,8 +93877,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Render a Markdown document */ "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -85263,6 +93909,7 @@ export interface operations { /** @example 279 */ "Content-Length"?: string; "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -85271,11 +93918,13 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Render a Markdown document in raw mode - * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - */ "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "text/plain": string; @@ -85287,6 +93936,7 @@ export interface operations { 200: { headers: { "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -85295,21 +93945,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a subscription plan for an account - * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/get-subscription-plan-for-account": { parameters: { + query?: never; + header?: never; path: { + /** @description account_id parameter */ account_id: components["parameters"]["account-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["marketplace-purchase"]; }; @@ -85317,30 +93969,34 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List plans - * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. - * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-plans": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-listing-plan"][]; @@ -85350,30 +94006,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List accounts for a plan - * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-accounts-for-plan": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the plan. */ plan_id: components["parameters"]["plan-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-purchase"][]; @@ -85384,21 +94042,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a subscription plan for an account (stubbed) - * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/get-subscription-plan-for-account-stubbed": { parameters: { + query?: never; + header?: never; path: { + /** @description account_id parameter */ account_id: components["parameters"]["account-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["marketplace-purchase"]; }; @@ -85406,28 +94066,32 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List plans (stubbed) - * @description Lists all plans that are part of your GitHub Enterprise Cloud Marketplace listing. - * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-plans-stubbed": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-listing-plan"][]; @@ -85436,30 +94100,32 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List accounts for a plan (stubbed) - * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/enterprise-cloud@latest//rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-accounts-for-plan-stubbed": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the plan. */ plan_id: components["parameters"]["plan-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-purchase"][]; @@ -85468,20 +94134,20 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * Get GitHub Enterprise Cloud meta information - * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/enterprise-cloud@latest//articles/about-github-s-ip-addresses/)." - * - * The API's response also includes a list of GitHub's domain names. - * - * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. - * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. - */ "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["api-overview"]; }; @@ -85489,21 +94155,30 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ "activity/list-public-events-for-repo-network": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -85514,27 +94189,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List notifications for the authenticated user - * @description List all notifications for the current user, sorted by most recently updated. - */ "activity/list-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -85546,11 +94227,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud 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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -85567,6 +94250,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -85575,26 +94261,33 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread - * @description Gets information about a notification thread. - */ "activity/get-thread": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread"]; }; @@ -85604,57 +94297,67 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Mark a thread as done - * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub Enterprise Cloud as done: https://github.com/notifications. - */ "activity/mark-thread-as-done": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Mark a thread as read - * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Cloud: https://github.com/notifications. - */ "activity/mark-thread-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription). - * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - */ "activity/get-thread-subscription-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -85664,19 +94367,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Set a thread subscription - * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. - * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription) endpoint. - */ "activity/set-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85692,6 +94391,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -85701,65 +94403,73 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. - */ "activity/delete-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get Octocat - * @description Get the octocat as ASCII art - */ "meta/get-octocat": { parameters: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/octocat-stream": string; }; }; }; }; - /** - * List organizations - * @description Lists all organizations, in the order that they were created. - * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. - */ "orgs/list": { parameters: { query?: { + /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -85768,28 +94478,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Deprecated - List custom repository roles in an organization - * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. - * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-roles": { parameters: { + query?: never; + header?: never; path: { /** @description The unique identifier of the organization. */ organization_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -85803,38 +94508,23 @@ export interface operations { }; }; }; - /** - * Get an organization - * @description Gets information about an organization. - * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-cloud@latest//articles/securing-your-account-with-two-factor-authentication-2fa/). - * - * To see the full details about an organization, the authenticated user must be an organization owner. - * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. - * - * To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the `Organization plan` permission. - */ "orgs/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -85842,54 +94532,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization - * @description Deletes an organization and all its repositories. - * - * The organization login will be unavailable for 90 days after deletion. - * - * Please review the Terms of Service regarding account deletion before using this endpoint: - * - * https://docs.github.com/enterprise-cloud@latest//site-policy/github-terms/github-terms-of-service - */ "orgs/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Cloud 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). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-cloud@latest//code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85931,7 +94599,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -85962,53 +94630,41 @@ export interface operations { web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ blog?: string; - /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + /** @description Whether Dependabot alerts is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + /** @description Whether Dependabot security updates is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** - * @description Whether dependency graph is automatically enabled for new repositories. + /** @description Whether dependency graph is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning is automatically enabled for new repositories. + /** @description Whether secret scanning is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + /** @description Whether secret scanning push protection is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -86022,6 +94678,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -86029,6 +94688,9 @@ export interface operations { 409: components["responses"]["conflict"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -86037,24 +94699,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage for an organization - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -86062,28 +94723,28 @@ export interface operations { }; }; }; - /** - * List repositories with GitHub Actions cache usage for an organization - * @description Lists repositories and their 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-by-repo-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86094,38 +94755,38 @@ export interface operations { }; }; }; - /** - * Get the customization template for an OIDC subject claim for an organization - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "oidc/get-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A JSON serialized template for OIDC subject claim customization */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub"]; }; }; }; }; - /** - * Set the customization template for an OIDC subject claim for an organization - * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "oidc/update-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86135,6 +94796,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -86143,40 +94807,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GitHub Actions permissions for an organization - * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-organization-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an organization - * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86189,29 +94851,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -86221,18 +94889,15 @@ export interface operations { }; }; }; - /** - * Set selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-selected-repositories-enabled-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86245,86 +94910,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/enable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/disable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions and reusable workflows for an organization - * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an organization - * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86334,46 +95004,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an organization - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an organization - * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86383,34 +95052,44 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an organization - * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runner-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ visible_to_repository?: components["parameters"]["visible-to-repository"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -86420,17 +95099,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an organization - * @description Creates a new self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/create-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86465,66 +95142,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Get a self-hosted runner group for an organization - * @description Gets a specific self-hosted runner group for an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an organization - * @description Deletes a self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-group-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an organization - * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/update-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86554,32 +95239,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * List repository access to a self-hosted runner group in an organization - * @description Lists the repositories with access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -86589,18 +95281,17 @@ export interface operations { }; }; }; - /** - * Set repository access for a self-hosted runner group in an organization - * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86613,74 +95304,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add repository access to a self-hosted runner group in an organization - * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove repository access to a self-hosted runner group in an organization - * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an organization - * @description Lists self-hosted runners that are in a specific organization group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runners-in-group-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86691,18 +95395,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an organization - * @description Replaces the list of self-hosted runners that are part of an organization runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-self-hosted-runners-in-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86715,77 +95418,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an organization - * @description Adds a self-hosted runner to a runner group configured in an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-self-hosted-runner-to-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an organization - * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-self-hosted-runner-from-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an organization - * @description Lists all self-hosted runners configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-self-hosted-runners-for-org": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86796,42 +95509,38 @@ export interface operations { }; }; }; - /** - * List runner applications for an organization - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-runner-applications-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for an organization - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the organization. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86856,145 +95565,129 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for an organization - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an organization - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an organization - * @description Gets a specific self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/get-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an organization - * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an organization - * @description Lists all labels for a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an organization - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-custom-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87010,20 +95703,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an organization - * @description Adds custom labels to a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87039,77 +95729,67 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an organization - * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an organization - * @description Remove a custom label from a self-hosted runner configured - * in an organization. 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. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-custom-label-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87120,138 +95800,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "actions/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -87273,61 +95880,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -87337,22 +95952,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -87365,91 +95975,97 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization variables - * @description Lists all organization variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87460,19 +96076,15 @@ export interface operations { }; }; }; - /** - * Create an organization variable - * @description Creates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -87494,72 +96106,74 @@ export interface operations { responses: { /** @description Response when creating a variable */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an organization variable - * @description Gets a specific variable in an organization. - * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-variable"]; }; }; }; }; - /** - * Delete an organization variable - * @description Deletes an organization variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an organization variable - * @description Updates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/update-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -87581,33 +96195,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization variable - * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-variable": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -87617,26 +96235,24 @@ export interface operations { }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set selected repositories for an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -87649,118 +96265,135 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get announcement banner for organization - * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. - */ "announcement-banners/get-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Remove announcement banner from organization - * @description Removes the announcement banner currently set for the organization. - */ "announcement-banners/remove-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set announcement banner for organization - * @description Sets the announcement banner to display for the organization. - */ "announcement-banners/set-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -87770,150 +96403,182 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." - * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-cloud@latest//organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." - * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." - * - * This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "[Rate limits for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api)" and "[Best practices for integrators](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. - */ "orgs/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List users blocked by an organization - * @description List the users blocked by an organization. - */ "orgs/list-blocked-users": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - /** - * Check if a user is blocked by an organization - * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. - */ "orgs/check-blocked-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the user is blocked */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description If the user is not blocked */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Block a user from an organization - * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. - */ "orgs/block-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Unblock a user from an organization - * @description Unblocks the given user on behalf of the specified organization. - */ "orgs/unblock-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-org": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; @@ -87922,15 +96587,20 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -87940,25 +96610,28 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List codespaces for the organization - * @description Lists the codespaces associated to a specified organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/list-in-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -87973,17 +96646,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Manage access control for organization codespaces - * @deprecated - * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/set-codespaces-access": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88005,33 +96676,33 @@ export interface operations { responses: { /** @description Response when successfully modifying permissions. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Add users to Codespaces access for an organization - * @deprecated - * @description Codespaces for the specified users will be billed to the organization. - * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/set-codespaces-access-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88044,33 +96715,33 @@ export interface operations { responses: { /** @description Response when successfully modifying permissions. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Remove users from Codespaces access for an organization - * @deprecated - * @description Codespaces for the specified users will no longer be billed to the organization. - * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/delete-codespaces-access-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88083,40 +96754,46 @@ export interface operations { responses: { /** @description Response when successfully modifying permissions. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List organization secrets - * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88127,44 +96804,48 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets an organization development environment secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["codespaces-org-secret"]; @@ -88172,19 +96853,17 @@ export interface operations { }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -88206,60 +96885,72 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an organization secret - * @description Deletes an organization development environment secret using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -88270,20 +96961,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization development environment 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/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -88296,91 +96984,104 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization development environment 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/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization development environment 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/enterprise-cloud@latest//rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/get-copilot-organization-details": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-organization-details"]; }; @@ -88390,37 +97091,36 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description There is a problem with your account's associated payment method. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/list-copilot-seats": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88436,26 +97136,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/add-copilot-seats-for-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88468,6 +97157,9 @@ export interface operations { responses: { /** @description OK */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_created: number; @@ -88479,31 +97171,23 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/cancel-copilot-seat-assignment-for-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88516,6 +97200,9 @@ export interface operations { responses: { /** @description OK */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_cancelled: number; @@ -88527,31 +97214,23 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/add-copilot-seats-for-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88564,6 +97243,9 @@ export interface operations { responses: { /** @description OK */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_created: number; @@ -88575,31 +97257,23 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/enterprise-cloud@latest//billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/enterprise-cloud@latest//copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/cancel-copilot-seat-assignment-for-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88612,6 +97286,9 @@ export interface operations { responses: { /** @description OK */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_cancelled: number; @@ -88623,28 +97300,14 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. - * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. - */ "copilot/usage-metrics-for-org": { parameters: { query?: { @@ -88652,17 +97315,25 @@ export interface operations { since?: string; /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-usage-metrics"][]; }; @@ -88673,76 +97344,76 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List SAML SSO authorizations for an organization - * @description Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials are either personal access tokens or SSH keys that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest//articles/about-authentication-with-saml-single-sign-on). - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "orgs/list-saml-sso-authorizations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description Page token */ page?: number; /** @description Limits the list of credentials authorizations for an organization to a specific login */ login?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["credential-authorization"][]; }; }; }; }; - /** - * Remove a SAML SSO authorization for an organization - * @description Removes a credential authorization for an organization that uses SAML SSO. Once you remove someone's credential authorization, they will need to create a new personal access token or SSH key and authorize it for the organization they want to access. - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/remove-saml-sso-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; credential_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-repo-roles": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -88756,19 +97427,15 @@ export interface operations { }; }; }; - /** - * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/create-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88778,6 +97445,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -88786,24 +97456,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/get-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -88811,43 +97482,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a custom repository role - * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/delete-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/update-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88857,6 +97525,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -88865,23 +97536,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Deprecated - Create a custom role - * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Create a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role)" endpoint instead. - * - * Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/create-custom-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88891,6 +97554,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -88899,28 +97565,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Deprecated - Get a custom role - * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Get a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role)" endpoint instead. - * - * Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/get-custom-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -88928,51 +97591,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Deprecated - Delete a custom role - * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Delete a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role)" endpoint instead. - * - * 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/delete-custom-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Deprecated - Update a custom role - * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[Update a custom repository role](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role)" endpoint instead. - * - * Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "orgs/update-custom-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88982,6 +97634,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -88990,37 +97645,60 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List Dependabot alerts for an organization - * @description Lists Dependabot alerts for an organization. - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-org": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -89032,28 +97710,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89064,134 +97742,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "dependabot/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -89213,57 +97822,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -89273,20 +97894,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -89299,79 +97917,92 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get list of conflicting packages during Docker migration for organization - * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -89380,73 +98011,84 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ "activity/list-public-org-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * Get an external group - * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/external-idp-group-info-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the group. */ group_id: components["parameters"]["group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List external groups in an organization - * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Cloud generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-external-idp-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description Page token */ page?: number; /** @description Limits the list to groups containing the text in the group name */ display_name?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["external-groups"]; @@ -89454,25 +98096,28 @@ export interface operations { }; }; }; - /** - * List failed organization invitations - * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. - */ "orgs/list-failed-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -89481,55 +98126,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Deprecated - List fine-grained permissions for an organization - * @deprecated - * @description **Note**: This operation is deprecated and will be removed after September 6th 2023. - * Use the "[List fine-grained repository permissions](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" endpoint instead. - * - * Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * To use this endpoint the authenticated user must be an administrator of the organization or of a repository of the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-fine-grained-permissions": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-fine-grained-permission"][]; }; }; }; }; - /** - * List organization webhooks - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"][]; @@ -89538,18 +98179,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -89570,8 +98208,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -89588,6 +98226,7 @@ export interface operations { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"]; @@ -89597,23 +98236,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -89621,41 +98262,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89670,8 +98311,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -89687,6 +98328,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -89695,42 +98339,42 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for an organization - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an organization - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89745,34 +98389,40 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -89781,24 +98431,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook delivery for an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -89807,94 +98459,95 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping an organization webhook - * @description You must be an organization owner or have the "Manage organization webhooks" permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks - * that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an organization installation for the authenticated app - * @description Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-org-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. - */ "orgs/list-app-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89905,19 +98558,23 @@ export interface operations { }; }; }; - /** - * Get interaction restrictions for an organization - * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. - */ "interactions/get-restrictions-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["interaction-limit-response"] @@ -89926,15 +98583,15 @@ export interface operations { }; }; }; - /** - * Set interaction restrictions for an organization - * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. - */ "interactions/set-restrictions-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -89944,6 +98601,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["interaction-limit-response"]; }; @@ -89951,31 +98611,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove interaction restrictions for an organization - * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. - */ "interactions/remove-restrictions-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List pending organization invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. - */ "orgs/list-pending-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Filter invitations by their member role. */ role?: @@ -89987,15 +98649,20 @@ export interface operations { /** @description Filter invitations by their invitation source. */ invitation_source?: "all" | "member" | "scim"; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -90004,18 +98671,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization invitation - * @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. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - */ "orgs/create-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90026,10 +98690,10 @@ export interface operations { email?: string; /** * @description The role for the new member. - * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. - * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. * @default direct_member * @enum {string} */ @@ -90042,6 +98706,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-invitation"]; }; @@ -90050,48 +98717,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Cancel an organization invitation - * @description 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/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). - */ "orgs/cancel-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List organization invitation teams - * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. - */ "orgs/list-invitation-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -90100,22 +98774,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization issues assigned to the authenticated user - * @description List issues in an organization assigned to the authenticated user. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-org": { parameters: { query?: { @@ -90129,23 +98787,33 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -90154,10 +98822,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization members - * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. - */ "orgs/list-members": { parameters: { query?: { @@ -90165,18 +98829,25 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -90185,75 +98856,93 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Check organization membership for a user - * @description Check if a user is, publicly or privately, a member of the organization. - */ "orgs/check-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if requester is an organization member and user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if requester is not an organization member */ 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization member - * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - */ "orgs/remove-member": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * List codespaces for a user in organization - * @description Lists the codespaces that a member of an organization has for repositories in that organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/get-codespaces-for-user-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -90268,20 +98957,21 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete a codespace from the organization - * @description Deletes a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/delete-from-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 304: components["responses"]["not_modified"]; @@ -90291,23 +98981,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Stop a codespace for an organization user - * @description Stops a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/stop-in-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -90319,26 +99013,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/get-copilot-seat-details-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The user's GitHub Copilot seat details, including usage. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-seat-details"]; }; @@ -90348,25 +99041,33 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Get organization membership for a user - * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. - */ "orgs/get-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -90375,32 +99076,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set organization membership for a user - * @description Only authenticated organization owners can add a member to the organization or update the member's role. - * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. - * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. - * - * **Rate limits** - * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. - */ "orgs/set-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. * @default member * @enum {string} */ @@ -90411,6 +99105,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -90419,51 +99116,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove organization membership for a user - * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - */ "orgs/remove-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List organization migrations - * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). - * - * A list of `repositories` is only returned for export migrations. - */ "migrations/list-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -90471,15 +99172,15 @@ export interface operations { }; }; }; - /** - * Start an organization migration - * @description Initiates the generation of a migration archive. - */ "migrations/start-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -90534,6 +99235,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -90542,36 +99246,31 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization migration status - * @description Fetches the status of a migration. - * - * The `state` of a migration can be one of the following values: - * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ "migrations/get-status-for-org": { parameters: { query?: { /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** - * @description * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -90579,84 +99278,104 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download an organization migration archive - * @description Fetches the URL to a migration archive. - */ "migrations/download-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization migration archive - * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. - */ "migrations/delete-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. - */ "migrations/unlock-repo-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List repositories in an organization migration - * @description List all the repositories for this organization migration. - */ "migrations/list-repos-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -90665,28 +99384,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-organization-fine-grained-permissions": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-fine-grained-permission"][]; }; @@ -90695,26 +99409,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-org-roles": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of organization roles */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description The total number of organization roles available to the organization. */ @@ -90728,22 +99439,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/create-custom-organization-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -90760,6 +99464,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-role"]; }; @@ -90769,179 +99476,199 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-all-org-roles-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/assign-team-to-org-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization, team or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-org-role-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-all-org-roles-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/assign-user-to-org-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization, user or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-org-role-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/get-org-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-role"]; }; @@ -90950,49 +99677,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/delete-custom-organization-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "orgs/patch-custom-organization-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91009,6 +99727,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-role"]; }; @@ -91018,30 +99739,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, you must be an administrator for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-org-role-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - List of assigned teams */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -91049,38 +99770,44 @@ export interface operations { }; /** @description Response if the organization or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, you must be an administrator for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-org-role-users": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - List of assigned users */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -91088,35 +99815,44 @@ export interface operations { }; /** @description Response if the organization or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List outside collaborators for an organization - * @description List all users who are outside collaborators of an organization. - */ "orgs/list-outside-collaborators": { parameters: { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -91124,16 +99860,17 @@ export interface operations { }; }; }; - /** - * Convert an organization member to outside collaborator - * @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/enterprise-cloud@latest//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)." - */ "orgs/convert-member-to-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -91149,39 +99886,56 @@ export interface operations { responses: { /** @description User is getting converted asynchronously */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description User was converted */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @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/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)." */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Remove outside collaborator from an organization - * @description Removing a user from this list will remove them from all the organization's repositories. - */ "orgs/remove-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -91191,12 +99945,6 @@ export interface operations { }; }; }; - /** - * List packages for an organization - * @description Lists packages in an organization readable by the user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-organization": { parameters: { query: { @@ -91208,19 +99956,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -91230,112 +99989,120 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for an organization - * @description Gets a specific package in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for an organization - * @description Restores an entire package in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-org": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by an organization - * @description Lists package versions for a package owned by an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -91345,116 +100112,131 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for an organization - * @description Gets a specific package version in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for an organization - * @description Restores a specific package version in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-requests": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; @@ -91466,17 +100248,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-requests-in-bulk": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -91501,19 +100281,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-request": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; requestBody: { content: { @@ -91536,29 +100314,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-request-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -91569,34 +100348,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grants": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant"][]; @@ -91608,17 +100395,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-accesses": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -91641,18 +100426,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-access": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the fine-grained personal access token. */ pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91673,29 +100457,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the fine-grained personal access token. */ pat_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -91706,27 +100491,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-org": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -91735,15 +100523,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -91758,6 +100546,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -91769,20 +100560,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get all custom properties for an organization - * @description Gets all custom properties defined for an organization. - * Organization members can read these properties. - */ "orgs/get-all-custom-properties": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"][]; }; @@ -91791,19 +100585,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update custom properties for an organization - * @description Creates new or updates existing custom properties defined for an organization in a batch. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - */ "orgs/create-or-update-custom-properties": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -91816,6 +100606,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"][]; }; @@ -91824,21 +100617,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a custom property for an organization - * @description Gets a custom property that is defined for an organization. - * Organization members can read these properties. - */ "orgs/get-custom-property": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The custom property name. The name is case sensitive. */ custom_property_name: components["parameters"]["custom-property-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"]; }; @@ -91847,20 +100644,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update a custom property for an organization - * @description Creates a new or updates an existing custom property that is defined for an organization. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - */ "orgs/create-or-update-custom-property": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The custom property name. The name is case sensitive. */ custom_property_name: components["parameters"]["custom-property-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -91874,13 +100668,11 @@ export interface operations { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | string[] | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ description?: string | null; - /** - * @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. - */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; }; }; @@ -91888,6 +100680,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"]; }; @@ -91896,49 +100691,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom property for an organization - * @description Removes a custom property that is defined for an organization. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - */ "orgs/remove-custom-property": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The custom property name. The name is case sensitive. */ custom_property_name: components["parameters"]["custom-property-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List custom property values for organization repositories - * @description Lists organization repositories with all of their custom property values. - * Organization members can read these properties. - */ "orgs/list-custom-properties-values-for-repos": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/enterprise-cloud@latest//articles/searching-for-repositories/)" for a detailed list of qualifiers. */ repository_query?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-repo-custom-property-values"][]; @@ -91948,24 +100743,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update custom property values for organization repositories - * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. - * Each target repository will have its custom property values updated to match the values provided in the request. - * - * A maximum of 30 repositories can be updated in a single request. - * - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. - */ "orgs/create-or-update-custom-properties-values-for-repos": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -91980,32 +100766,38 @@ export interface operations { responses: { /** @description No Content when custom property values are successfully created or updated */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List public organization members - * @description Members of an organization can choose to have their membership publicized or not. - */ "orgs/list-public-members": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -92013,73 +100805,83 @@ export interface operations { }; }; }; - /** - * Check public organization membership for a user - * @description Check if the provided user is a public member of the organization. - */ "orgs/check-public-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a public member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a public member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set public organization membership for the authenticated user - * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - */ "orgs/set-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Remove public organization membership for the authenticated user - * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. - */ "orgs/remove-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization repositories - * @description 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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/list-for-org": { parameters: { query?: { @@ -92089,18 +100891,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -92108,17 +100917,15 @@ export interface operations { }; }; }; - /** - * Create an organization repository - * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -92210,34 +101017,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -92254,6 +101061,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -92263,46 +101071,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-repo-fine-grained-permissions": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-fine-grained-permission"][]; }; }; }; }; - /** - * Get all organization repository rulesets - * @description Get all the repository rulesets for an organization. - */ "repos/get-org-rulesets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"][]; }; @@ -92311,15 +101124,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create an organization repository ruleset - * @description Create a repository ruleset for an organization. - */ "repos/create-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; /** @description Request body */ requestBody: { @@ -92330,7 +101143,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -92346,6 +101159,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -92354,28 +101170,38 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List organization rule suites - * @description Lists suites of rule evaluations at the organization level. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." - */ "repos/get-org-rule-suites": { parameters: { query?: { + /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; + /** @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suites"]; }; @@ -92384,21 +101210,28 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get an organization rule suite - * @description Gets information about a suite of rule evaluations from within an organization. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." - */ "repos/get-org-rule-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. */ rule_suite_id: components["parameters"]["rule-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suite"]; }; @@ -92407,21 +101240,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get an organization repository ruleset - * @description Get a repository ruleset for an organization. - */ "repos/get-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -92430,17 +101267,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update an organization repository ruleset - * @description Update a ruleset for an organization. - */ "repos/update-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; /** @description Request body */ requestBody?: { @@ -92451,7 +101288,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -92467,6 +101304,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -92475,58 +101315,71 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete an organization repository ruleset - * @description Delete a ruleset for an organization. - */ "repos/delete-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List secret scanning alerts for an organization - * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-org": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -92536,34 +101389,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository security advisories for an organization - * @description Lists repository security advisories for an organization. - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/list-org-repository-advisories": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"][]; }; @@ -92572,198 +101427,204 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "orgs/list-security-manager-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - /** - * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/add-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The organization has reached the maximum number of security manager teams. */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/remove-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. - * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - */ "billing/get-github-actions-billing-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-billing-usage"]; }; }; }; }; - /** - * Get GitHub Advanced Security active committers for an organization - * @description 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. - */ "billing/get-github-advanced-security-billing-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; }; }; }; - /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - */ "billing/get-github-packages-billing-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["packages-billing-usage"]; }; }; }; }; - /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - */ "billing/get-shared-storage-billing-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-billing-usage"]; }; }; }; }; - /** - * List IdP groups for an organization - * @description Lists IdP groups available in an organization. - */ "teams/list-idp-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description Page token */ page?: string; /** @description Filters the results to return only those that begin with the value specified by this parameter. For example, a value of `ab` will return results that begin with "ab". */ q?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["group-mapping"]; @@ -92771,25 +101632,6 @@ export interface operations { }; }; }; - /** - * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. - * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. - */ "copilot/usage-metrics-for-team": { parameters: { query?: { @@ -92797,18 +101639,27 @@ export interface operations { since?: string; /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-usage-metrics"][]; }; @@ -92819,25 +101670,28 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List teams - * @description Lists all teams in an organization that are visible to the authenticated user. - */ "teams/list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -92846,17 +101700,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a team - * @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/enterprise-cloud@latest//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/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/about-teams)". - */ "teams/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -92871,21 +101723,21 @@ export interface operations { repo_names?: string[]; /** * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` * @enum {string} */ notification_setting?: @@ -92905,6 +101757,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -92913,22 +101768,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a team by name - * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Cloud replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. - */ "teams/get-by-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -92936,40 +101794,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team - * @description To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - */ "teams/delete-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a team - * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - */ "teams/update-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92980,18 +101838,18 @@ export interface operations { description?: string; /** * @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: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -93011,12 +101869,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -93026,33 +101890,34 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Pinned discussions only filter */ pinned?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -93060,22 +101925,17 @@ export interface operations { }; }; }; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -93095,75 +101955,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93178,38 +102043,43 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -93217,23 +102087,19 @@ export interface operations { }; }; }; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * **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`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -93246,78 +102112,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -93330,20 +102204,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { @@ -93357,21 +102226,31 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -93379,24 +102258,21 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -93420,51 +102296,53 @@ export interface operations { responses: { /** @description Response when the reaction type has already been added to this team discussion comment */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { @@ -93478,20 +102356,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -93499,23 +102386,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -93539,96 +102422,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List a connection between an external group and a team - * @description Lists a connection between a team and an external group. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-linked-external-idp-groups-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-groups"]; }; }; }; }; - /** - * Remove the connection between an external group and a team - * @description Deletes a connection between a team and an external group. - * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update the connection between an external group and a team - * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/link-external-idp-group-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -93644,34 +102541,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List pending team invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. - */ "teams/list-pending-invitations-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -93679,30 +102581,32 @@ export interface operations { }; }; }; - /** - * List team members - * @description Team members will include the members of child teams. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/list-members-in-org": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -93710,61 +102614,53 @@ export interface operations { }; }; }; - /** - * Get team membership for a user - * @description Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). - */ "teams/get-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ 404: { - content: never; - }; - }; - }; - /** - * Add or update team membership for a user - * @description 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//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. - * - * If 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. - * - * **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}`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-or-update-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93781,71 +102677,85 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user - * @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. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//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}`. - */ "teams/remove-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ "teams/list-projects-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -93853,46 +102763,53 @@ export interface operations { }; }; }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/check-permissions-for-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/add-or-update-project-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93908,10 +102825,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -93921,49 +102844,55 @@ export interface operations { }; }; }; - /** - * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/remove-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team repositories - * @description Lists a team's repositories visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - */ "teams/list-repos-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -93971,60 +102900,64 @@ export interface operations { }; }; }; - /** - * Check team permissions for a repository - * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. - * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/check-permissions-for-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with repository permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team does not have permission for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions - * @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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **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/enterprise-cloud@latest//github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". - */ "teams/add-or-update-repo-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94040,70 +102973,76 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a repository from a team - * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/remove-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List IdP groups for a team - * @description List IdP groups connected to a team on GitHub Enterprise Cloud. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. - */ "teams/list-idp-groups-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["group-mapping"]; }; }; }; }; - /** - * Create or update IdP group connections - * @description Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/team-sync/group-mappings`. - */ "teams/create-or-update-idp-group-connections-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -94123,34 +103062,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["group-mapping"]; }; }; }; }; - /** - * List child teams - * @description Lists the child teams of the team specified by `{team_slug}`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - */ "teams/list-child-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -94158,28 +103102,29 @@ export interface operations { }; }; }; - /** - * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ enablement: components["parameters"]["org-security-product-enablement"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. - * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. * @enum {string} */ query_suite?: "default" | "extended"; @@ -94189,27 +103134,37 @@ export interface operations { responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a project card - * @description Gets information about a project card. - */ "projects/get-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -94220,25 +103175,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project card - * @description Deletes a project card - */ "projects/delete-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94250,12 +103212,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ "projects/update-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94276,6 +103241,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -94287,12 +103255,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ "projects/move-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94313,6 +103284,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -94321,6 +103295,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94337,6 +103314,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -94351,19 +103331,23 @@ export interface operations { }; }; }; - /** - * Get a project column - * @description Gets information about a project column. - */ "projects/get-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -94374,32 +103358,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project column - * @description Deletes a project column. - */ "projects/delete-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ "projects/update-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94415,6 +103406,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -94424,27 +103418,30 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List project cards - * @description Lists the project cards in a project. - */ "projects/list-cards": { parameters: { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-card"][]; @@ -94455,25 +103452,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ "projects/create-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** * @description The project card's note * @example Update all gems */ note: string | null; - }, - { + } + | { /** * @description The unique identifier of the content associated with the card * @example 42 @@ -94484,14 +103483,15 @@ export interface operations { * @example PullRequest */ content_type: string; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -94501,6 +103501,9 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -94509,6 +103512,9 @@ export interface operations { }; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -94523,12 +103529,15 @@ export interface operations { }; }; }; - /** Move a project column */ "projects/move-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94544,6 +103553,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -94554,19 +103566,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -94576,25 +103592,32 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ "projects/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Delete Success */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94607,15 +103630,15 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94648,6 +103671,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -94656,6 +103682,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94666,33 +103695,39 @@ export interface operations { }; /** @description Not Found if the authenticated user does not have access to the project */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 410: components["responses"]["gone"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ "projects/list-collaborators": { parameters: { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -94705,16 +103740,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ "projects/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94732,7 +103768,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -94741,21 +103780,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ "projects/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -94764,20 +103808,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ "projects/get-permission-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-collaborator-permission"]; }; @@ -94789,25 +103838,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List project columns - * @description Lists the project columns in a project. - */ "projects/list-columns": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-column"][]; @@ -94818,15 +103870,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a project column - * @description Creates a new project column. - */ "projects/create-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94842,6 +103894,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -94852,24 +103907,14 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. - * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - */ "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -94877,6 +103922,7 @@ export interface operations { "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["rate-limit-overview"]; @@ -94886,22 +103932,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository - * @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. - * - * **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/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -94911,30 +103960,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a repository - * @description Deleting a repository requires admin access. - * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. - * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. - */ "repos/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94945,16 +103997,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics) endpoint. - */ "repos/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94967,7 +104020,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -94976,16 +104029,14 @@ export interface operations { * @enum {string} */ visibility?: "public" | "private" | "internal"; - /** - * @description Specify which security and analysis features to enable or disable for the repository. + /** @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. * - * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { @@ -95069,34 +104120,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -95121,6 +104172,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -95131,31 +104185,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List artifacts for a repository - * @description Lists all artifacts for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-artifacts-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -95166,129 +104221,143 @@ export interface operations { }; }; }; - /** - * Get an artifact - * @description Gets a specific artifact for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["artifact"]; }; }; }; }; - /** - * Delete an artifact - * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download an artifact - * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; archive_format: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { Location: components["headers"]["location"]; + [name: string]: unknown; }; - content: never; + content?: never; }; 410: components["responses"]["gone"]; }; }; - /** - * Get GitHub Actions cache usage for a repository - * @description Gets GitHub Actions cache usage for a repository. - * 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. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-by-repository"]; }; }; }; }; - /** - * List GitHub Actions caches for a repository - * @description Lists the GitHub Actions caches for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; + /** @description An explicit key or prefix for identifying the cache */ key?: components["parameters"]["actions-cache-key"]; + /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ sort?: components["parameters"]["actions-cache-list-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-list"]; @@ -95296,119 +104365,128 @@ export interface operations { }; }; }; - /** - * Delete GitHub Actions caches for a repository (using a cache key) - * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-key": { parameters: { query: { + /** @description A key for identifying the cache. */ key: components["parameters"]["actions-cache-key-required"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - /** - * Delete a GitHub Actions cache for a repository (using a cache ID) - * @description Deletes a GitHub Actions cache for a repository, using a cache ID. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-id": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the GitHub Actions cache. */ cache_id: components["parameters"]["cache-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a job for a workflow run - * @description Gets a specific job in a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["job"]; }; }; }; }; - /** - * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-job-logs-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Re-run a job from a workflow run - * @description Re-run a job and its dependent jobs in a workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95424,6 +104502,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -95431,22 +104512,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get the customization template for an OIDC subject claim for a repository - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub-repo"]; }; @@ -95455,18 +104539,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set the customization template for an OIDC subject claim for a repository - * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95481,6 +104564,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -95490,31 +104576,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository organization secrets - * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -95525,30 +104610,30 @@ export interface operations { }; }; }; - /** - * List repository organization variables - * @description Lists all organization variables shared with a repository. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -95559,42 +104644,42 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions permissions for a repository - * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-repository-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for a repository - * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. - * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95607,50 +104692,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-workflow-access-to-repository"]; }; }; }; }; - /** - * Set the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-cloud@latest//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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-cloud@latest//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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95660,48 +104744,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions and reusable workflows for a repository - * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for a repository - * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings and reusable workflows settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95711,48 +104796,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for a repository - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for a repository - * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-cloud@latest//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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95762,40 +104848,46 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning organization or enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for a repository - * @description Lists all self-hosted runners configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -95806,44 +104898,42 @@ export interface operations { }; }; }; - /** - * List runner applications for a repository - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-runner-applications-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for a repository - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the repository. - * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95868,151 +104958,141 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for a repository - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for a repository - * @description Gets a specific self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from a repository - * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for a repository - * @description Lists all labels for a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for a repository - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96028,21 +105108,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for a repository - * @description Adds custom labels to a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96058,89 +105136,89 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for a repository - * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for a repository - * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. - * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-custom-label-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List workflow runs for a repository - * @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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. - */ "actions/list-workflow-runs-for-repo": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96151,97 +105229,109 @@ export interface operations { }; }; }; - /** - * Get a workflow run - * @description Gets a specific workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * Delete a workflow run - * @description Deletes a specific workflow run. - * - * Anyone with write access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-reviews-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment-approvals"][]; }; }; }; }; - /** - * Approve a workflow run for a fork pull request - * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/enterprise-cloud@latest//actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/approve-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -96250,32 +105340,34 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List workflow run artifacts - * @description Lists artifacts for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-run-artifacts": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96286,62 +105378,66 @@ export interface operations { }; }; }; - /** - * Get a workflow run attempt - * @description Gets a specific workflow run attempt. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run-attempt": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96353,52 +105449,56 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download workflow run attempt logs - * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-attempt-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Cancel a workflow run - * @description Cancels a workflow run using its `id`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -96406,22 +105506,19 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/review-custom-gates-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96433,28 +105530,34 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Force cancel a workflow run - * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. - * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/force-cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -96462,34 +105565,34 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List jobs for a workflow run - * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run": { parameters: { query?: { /** @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. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96500,97 +105603,100 @@ export interface operations { }; }; }; - /** - * Download workflow run logs - * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Delete workflow run logs - * @description Deletes all logs for a workflow run. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Get pending deployments for a workflow run - * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pending-deployment"][]; }; }; }; }; - /** - * Review pending deployments for a workflow run - * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. - * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/review-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96598,9 +105704,9 @@ export interface operations { /** * @description The list of environment ids to approve or reject * @example [ - * 161171787, - * 161171795 - * ] + * 161171787, + * 161171795 + * ] */ environment_ids: number[]; /** @@ -96620,25 +105726,28 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"][]; }; }; }; }; - /** - * Re-run a workflow - * @description Re-runs your workflow run using its `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96654,25 +105763,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow-failed-jobs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96688,62 +105800,66 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get workflow run usage - * @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 Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-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/enterprise-cloud@latest//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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run-usage"]; }; }; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96754,72 +105870,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -96834,63 +105949,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository variables - * @description Lists all repository variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96901,20 +106024,17 @@ export interface operations { }; }; }; - /** - * Create a repository variable - * @description Creates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96929,75 +106049,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get a repository variable - * @description Gets a specific variable in a repository. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete a repository variable - * @description Deletes a repository variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a repository variable - * @description Updates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -97012,34 +106137,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository workflows - * @description Lists the workflows in a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-repo-workflows": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -97050,68 +106178,71 @@ export interface operations { }; }; }; - /** - * Get a workflow - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow"]; }; }; }; }; - /** - * Disable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/disable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * 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`. - * - * You 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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-workflow-dispatch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97128,64 +106259,80 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/enable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow runs for a workflow - * @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/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-runs": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-cloud@latest//actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-cloud@latest//search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -97196,66 +106343,57 @@ export interface operations { }; }; }; - /** - * Get workflow usage - * @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 Enterprise Cloud-hosted runners. Usage is listed for each GitHub Enterprise Cloud-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/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * 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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-usage"]; }; }; }; }; - /** - * List repository activities - * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. - * - * For more information about viewing repository activity, - * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." - */ "repos/list-activities": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; - /** - * @description The Git reference for the activities you want to list. + /** @description The Git reference for the activities you want to list. * - * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. - */ + * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. */ ref?: string; /** @description The GitHub username to use to filter by the actor who performed the activity. */ actor?: string; - /** - * @description The time period to filter by. + /** @description The time period to filter by. * - * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). - */ + * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). */ time_period?: "day" | "week" | "month" | "quarter" | "year"; - /** - * @description The activity type to filter by. + /** @description The activity type to filter by. * - * For example, you can choose to filter by "force_push", to see all force pushes to the repository. - */ + * For example, you can choose to filter by "force_push", to see all force pushes to the repository. */ activity_type?: | "push" | "force_push" @@ -97264,16 +106402,22 @@ export interface operations { | "pr_merge" | "merge_queue_merge"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["activity"][]; @@ -97282,26 +106426,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-cloud@latest//articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. - */ "issues/list-assignees": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -97310,67 +106458,75 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user can be assigned - * @description Checks if a user has permission to be assigned to an issue in this repository. - * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - * - * Otherwise a `404` status code is returned. - */ "issues/check-user-can-be-assigned": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Otherwise a `404` status code is returned. */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get all autolinks of a repository - * @description Gets all autolinks that are configured for a repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/list-autolinks": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"][]; }; }; }; }; - /** - * Create an autolink reference for a repository - * @description Users with admin access to the repository can create an autolink. - */ "repos/create-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97393,6 +106549,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["autolink"]; @@ -97401,23 +106558,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an autolink reference of a repository - * @description This returns a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/get-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"]; }; @@ -97425,107 +106586,136 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an autolink reference from a repository - * @description This deletes a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/delete-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". - */ "repos/check-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if dependabot is enabled */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; /** @description Not Found if dependabot is not enabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable automated security fixes - * @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/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". - */ "repos/enable-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable 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/enterprise-cloud@latest//articles/configuring-automated-security-fixes)". - */ "repos/disable-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List branches */ "repos/list-branches": { parameters: { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-branch"][]; @@ -97534,18 +106724,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get a branch */ "repos/get-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -97554,21 +106753,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get branch protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-protection"]; }; @@ -97576,23 +106781,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update branch protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Protecting a branch requires admin or owner permissions to the repository. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. - */ "repos/update-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -97604,6 +106805,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -97683,6 +106885,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch"]; }; @@ -97692,148 +106897,178 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete branch protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get admin branch protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Set admin branch protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/set-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Delete admin branch protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/delete-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get pull request review protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - /** - * Delete pull request review protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update pull request review protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - */ "repos/update-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97873,6 +107108,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; @@ -97880,25 +107118,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get commit signature protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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/enterprise-cloud@latest//articles/signing-commits-with-gpg) in GitHub Help. - * - * **Note**: You must enable branch protection to require signed commits. - */ "repos/get-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -97906,23 +107146,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create commit signature protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/create-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -97930,43 +107174,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete commit signature protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/delete-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get status checks protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-status-checks-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -97974,38 +107228,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove status check protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update status check protection - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/update-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98015,6 +107275,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -98030,6 +107291,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -98038,21 +107302,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all status check contexts - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-all-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -98060,17 +107330,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set status check contexts - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/set-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98083,6 +107355,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -98091,17 +107366,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add status check contexts - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/add-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98114,6 +107391,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -98123,17 +107403,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove status check contexts - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98146,6 +107428,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -98154,25 +107439,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists who has access to this protected branch. - * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. - */ "repos/get-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-restriction-policy"]; }; @@ -98180,44 +107467,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Disables the ability to restrict who can push to this branch. - */ "repos/delete-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get apps with access to the protected branch - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/get-apps-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -98225,19 +107520,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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/enterprise-cloud@latest//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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/set-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98250,6 +107545,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -98257,19 +107555,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/add-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98282,6 +107580,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -98289,19 +107590,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/remove-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98314,6 +107615,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -98321,23 +107625,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get teams with access to the protected branch - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. The list includes child teams. - */ "repos/get-teams-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -98345,19 +107653,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - */ "repos/set-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98370,6 +107678,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -98377,19 +107688,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified teams push access for this branch. You can also give push access to child teams. - */ "repos/add-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98402,6 +107713,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -98409,19 +107723,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. - */ "repos/remove-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98434,6 +107748,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -98441,23 +107758,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get users with access to the protected branch - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - */ "repos/get-users-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -98465,23 +107786,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set user 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/set-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98494,6 +107811,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -98501,23 +107821,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add user 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified people push access for this branch. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/add-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98530,6 +107846,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -98537,23 +107856,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a user to push to this branch. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/remove-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98566,6 +107881,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -98573,23 +107891,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Rename a branch - * @description Renames a branch in a repository. - * - * **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/enterprise-cloud@latest//github/administering-a-repository/renaming-a-branch)". - * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. - */ "repos/rename-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -98602,6 +107916,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -98611,20 +107928,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. - * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - */ "checks/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98650,7 +107964,7 @@ export interface operations { started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ conclusion?: @@ -98724,149 +108038,153 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Get a check run - * @description Gets a single check run using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Update a check run - * @description Updates a check run for a specific commit in a repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The name of the check. For example, "code-coverage". */ - name?: string; - /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; - /** @description A reference for the run on the integrator's system. */ - external_id?: string; - /** - * Format: date-time - * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. - * @enum {string} - */ - status?: - | "queued" - | "in_progress" - | "completed" - | "waiting" - | "requested" - | "pending"; - /** - * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. - * @enum {string} - */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; - /** - * Format: date-time - * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - completed_at?: string; - /** @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. */ - output?: { - /** @description **Required**. */ - title?: string; - /** @description Can contain Markdown. */ - summary: string; - /** @description Can contain Markdown. */ - text?: string; - /** @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/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". */ - annotations?: { - /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; - /** @description The start line of the annotation. Line numbers start at 1. */ - start_line: number; - /** @description The end line of the annotation. */ - end_line: number; - /** @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. */ - start_column?: number; - /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + "application/json": + | { + /** @description The name of the check. For example, "code-coverage". */ + name?: string; + /** @description The URL of the integrator's site that has the full details of the check. */ + details_url?: string; + /** @description A reference for the run on the integrator's system. */ + external_id?: string; /** - * @description The level of the annotation. + * Format: date-time + * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; - /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; - /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; - /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; - /** @description Adds images to the output displayed in the GitHub pull request UI. */ - images?: { - /** @description The alternative text for the image. */ - alt: string; - /** @description The full URL of the image. */ - image_url: string; - /** @description A short image description. */ - caption?: string; - }[]; - }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - actions?: { - /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; - /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; - /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - } & ( + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; + /** + * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * @enum {string} + */ + conclusion?: + | "action_required" + | "cancelled" + | "failure" + | "neutral" + | "success" + | "skipped" + | "stale" + | "timed_out"; + /** + * Format: date-time + * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** @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. */ + output?: { + /** @description **Required**. */ + title?: string; + /** @description Can contain Markdown. */ + summary: string; + /** @description Can contain Markdown. */ + text?: string; + /** @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/enterprise-cloud@latest//rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-cloud@latest//articles/about-status-checks#checks)". */ + annotations?: { + /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** @description The start line of the annotation. Line numbers start at 1. */ + start_line: number; + /** @description The end line of the annotation. */ + end_line: number; + /** @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. */ + start_column?: number; + /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** + * @description The level of the annotation. + * @enum {string} + */ + annotation_level: "notice" | "warning" | "failure"; + /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** @description The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** @description Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + }[]; + /** @description Adds images to the output displayed in the GitHub pull request UI. */ + images?: { + /** @description The alternative text for the image. */ + alt: string; + /** @description The full URL of the image. */ + image_url: string; + /** @description A short image description. */ + caption?: string; + }[]; + }; + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + actions?: { + /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + }[]; + } | { /** @enum {unknown} */ status?: "completed"; @@ -98876,42 +108194,47 @@ export interface operations { /** @enum {unknown} */ status?: "queued" | "in_progress"; [key: string]: unknown; - } - ); + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-annotations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["check-annotation"][]; @@ -98919,31 +108242,36 @@ export interface operations { }; }; }; - /** - * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -98951,26 +108279,26 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-cloud@latest//rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites)". - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/create-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98983,29 +108311,35 @@ export interface operations { responses: { /** @description Response when the suite already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. - */ "checks/set-suites-preferences": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99026,66 +108360,74 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - /** - * Get a check suite - * @description Gets a single check suite using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-suite": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -99096,47 +108438,47 @@ export interface operations { }; }; }; - /** - * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List code scanning alerts for a repository - * @description Lists code scanning alerts. - * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; @@ -99145,14 +108487,22 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-items"][]; }; @@ -99163,23 +108513,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning alert - * @description Gets a single code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -99190,18 +108544,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning alert - * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -99215,6 +108570,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -99224,28 +108582,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List instances of a code scanning alert - * @description Lists all instances of the specified code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alert-instances": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-instance"][]; }; @@ -99255,47 +108619,42 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List code scanning analyses for a repository - * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. - * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-recent-analyses": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the analyses 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`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"][]; }; @@ -99305,38 +108664,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning analysis for a repository - * @description Gets a specified code scanning analysis for a repository. - * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. - * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-analysis": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { @@ -99349,89 +108697,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. - * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/delete-analysis": { parameters: { query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ confirm_delete?: string | null; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; @@ -99442,22 +108731,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CodeQL databases for a repository - * @description Lists the CodeQL databases that are available in a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-codeql-databases": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-codeql-database"][]; }; @@ -99467,30 +108759,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a CodeQL database for a repository - * @description Gets a CodeQL database for a language in a repository. - * - * By default this endpoint returns JSON metadata about the CodeQL database. To - * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types), and make sure - * your HTTP client is configured to follow redirects or use the `Location` header - * to make a second request to get the redirect URL. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-codeql-database": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The language of the CodeQL database. */ language: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-codeql-database"]; }; @@ -99501,22 +108790,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning default setup configuration - * @description Gets a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup"]; }; @@ -99526,18 +108818,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning default setup configuration - * @description Updates a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99547,12 +108838,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; @@ -99563,47 +108860,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif)." - * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." - * - * You 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: - * - * ``` - * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." - * - * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/upload-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99614,7 +108881,7 @@ export interface operations { /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. - * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ checkout_uri?: string; @@ -99625,10 +108892,8 @@ export interface operations { started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ tool_name?: string; - /** - * @description Whether the SARIF file will be validated according to the code scanning specifications. - * This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. - */ + /** @description Whether the SARIF file will be validated according to the code scanning specifications. + * This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. */ validate?: boolean; }; }; @@ -99636,40 +108901,53 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ 413: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ sarif_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; @@ -99677,63 +108955,73 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CODEOWNERS errors - * @description List any syntax errors that are detected in the CODEOWNERS - * file. - * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - */ "repos/codeowners-errors": { parameters: { query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List codespaces in a repository for the authenticated user - * @description Lists the codespaces associated to a specified repository and the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/list-in-repository-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -99747,18 +109035,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a codespace in a repository - * @description Creates a codespace owned by the authenticated user in the specified repository. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/create-with-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99794,12 +109081,18 @@ export interface operations { responses: { /** @description Response when the codespace was successfully created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -99811,27 +109104,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List devcontainer configurations in a repository for the authenticated user - * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files - * specify launchpoint configurations for codespaces created within the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/list-devcontainers-in-repository-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -99850,12 +109146,6 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List available machine types for a repository - * @description List the machine types available for a given repository based on its configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/repo-machines-for-authenticated-user": { parameters: { query?: { @@ -99866,14 +109156,22 @@ export interface operations { /** @description The branch or commit to check for prebuild availability and devcontainer restrictions. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -99888,12 +109186,6 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get default attributes for a codespace - * @description Gets the default attributes for codespaces created by the user with the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/pre-flight-with-repo-for-authenticated-user": { parameters: { query?: { @@ -99902,14 +109194,22 @@ export interface operations { /** @description An alternative IP for default location auto-detection, such as when proxying a request. */ client_ip?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when a user is able to create codespaces from the repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { billable_owner?: components["schemas"]["simple-user"]; @@ -99925,12 +109225,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if permissions defined by a devcontainer have been accepted by the authenticated user - * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/check-permissions-for-devcontainer": { parameters: { query: { @@ -99939,14 +109233,22 @@ export interface operations { /** @description Path to the devcontainer.json configuration to use for the permission check. */ devcontainer_path: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when the permission check is successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; }; @@ -99958,29 +109260,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository secrets - * @description Lists all development environment secrets available in a repository without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -99991,68 +109294,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository development environment secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repo-codespaces-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -100067,48 +109373,47 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a development environment secret in a repository using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository collaborators - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/list-collaborators": { parameters: { query?: { @@ -100116,19 +109421,27 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["collaborator"][]; @@ -100137,66 +109450,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is a repository collaborator - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/check-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a collaborator */ 404: { - content: never; - }; - }; - }; - /** - * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * 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/enterprise-cloud@latest//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: - * - * ``` - * Cannot assign {member} permission of {role name} - * ``` - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations). - * - * **Updating an existing collaborator's permission level** - * - * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. - * - * **Rate limits** - * - * You 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. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -100212,85 +109510,75 @@ export interface operations { responses: { /** @description Response when a new invitation is created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; - /** - * @description Response when: - * - an existing collaborator is added as a collaborator - * - an organization member is added as an individual collaborator - * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator - */ + /** @description Response when: + * - an existing collaborator is added as a collaborator + * - an organization member is added as an individual collaborator + * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository collaborator - * @description Removes a collaborator from a repository. - * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. - * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages - * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. - * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". - */ "repos/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when collaborator was removed from the repository. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ "repos/get-collaborator-permission-level": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user has admin permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-collaborator-permission"]; }; @@ -100298,33 +109586,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit comments for a repository - * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-commit-comments-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -100332,28 +109617,27 @@ export interface operations { }; }; }; - /** - * Get a commit comment - * @description Gets a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/get-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -100361,41 +109645,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a commit comment */ "repos/delete-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a commit comment - * @description Updates the contents of a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/update-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -100408,6 +109696,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -100415,10 +109706,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). - */ "reactions/list-for-commit-comment": { parameters: { query?: { @@ -100432,20 +109719,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -100454,17 +109750,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. - */ "reactions/create-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -100488,12 +109786,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -100501,59 +109805,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment). - */ "reactions/delete-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List commits - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/list-commits": { parameters: { query?: { @@ -100565,22 +109843,31 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -100592,23 +109879,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List branches for HEAD commit - * @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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - */ "repos/list-branches-for-head-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-short"][]; }; @@ -100617,34 +109908,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List commit comments - * @description Lists the comments for a specified commit. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-comments-for-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -100652,26 +109941,19 @@ export interface operations { }; }; }; - /** - * Create a commit comment - * @description Create a comment for a commit using its `:commit_sha`. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/create-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; requestBody: { content: { @@ -100693,6 +109975,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"]; @@ -100702,29 +109985,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. - * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. - */ "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -100733,62 +110019,32 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a commit - * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/get-commit": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; @@ -100800,38 +110056,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-ref": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; app_id?: number; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -100842,14 +110099,6 @@ export interface operations { }; }; }; - /** - * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-suites-for-ref": { parameters: { query?: { @@ -100858,21 +110107,31 @@ export interface operations { * @example 1 */ app_id?: number; + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -100883,32 +110142,32 @@ export interface operations { }; }; }; - /** - * Get the combined status for a specific reference - * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - * - * - * Additionally, a combined `state` is returned. The `state` is one of: - * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` - */ "repos/get-combined-status-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-commit-status"]; }; @@ -100916,29 +110175,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit statuses for a reference - * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - */ "repos/list-commit-statuses-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"][]; @@ -100947,105 +110209,57 @@ export interface operations { 301: components["responses"]["moved_permanently"]; }; }; - /** - * Get community profile metrics - * @description Returns all community profile metrics for a repository. The repository 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, - * README, and CONTRIBUTING files. - * - * The `health_percentage` score is defined as a percentage of how many of - * the recommended community health files are present. For more information, see - * "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." - * - * `content_reports_enabled` is only returned for organization-owned repositories. - */ "repos/get-community-profile-metrics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["community-profile"]; }; }; }; }; - /** - * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. - * - * **Working with large comparisons** - * - * 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. - * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api)." - * - * **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: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits-with-basehead": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @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`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; @@ -101055,50 +110269,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. - * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. - * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - * - * **Notes**: - * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. - */ "repos/get-content": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/vnd.github.object": components["schemas"]["content-tree"]; "application/json": @@ -101113,22 +110307,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. - * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. - */ "repos/create-or-update-file-contents": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -101165,12 +110356,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -101180,26 +110377,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a file - * @description Deletes a file in a repository. - * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-cloud@latest//rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - */ "repos/delete-file": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -101230,6 +110420,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -101240,30 +110433,32 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository contributors - * @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. - * - * 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. - */ "repos/list-contributors": { parameters: { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If repository contains content */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["contributor"][]; @@ -101271,26 +110466,41 @@ export interface operations { }; /** @description Response if repository is empty */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List Dependabot alerts for a repository - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-repo": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** * @deprecated @@ -101302,19 +110512,35 @@ export interface operations { * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"][]; }; @@ -101326,21 +110552,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a Dependabot alert - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -101350,26 +110585,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The state of the Dependabot alert. - * A `dismissed_reason` must be provided when setting the state to `dismissed`. + * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ state: "dismissed" | "open"; @@ -101391,6 +110629,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -101402,29 +110643,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -101435,67 +110677,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. - */ "dependabot/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -101510,58 +110756,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a diff of the dependencies between commits - * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. - */ "dependency-graph/diff-range": { parameters: { query?: { + /** @description The full path, relative to the repository root, of the dependency manifest file. */ name?: components["parameters"]["manifest-path"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-diff"]; @@ -101571,22 +110830,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Export a software bill of materials (SBOM) for a repository. - * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. - */ "dependency-graph/export-sbom": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; @@ -101596,20 +110858,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. - * - * The authenticated user must have access to the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependency-graph/create-repository-snapshot": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -101619,6 +110878,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description ID of the created snapshot. */ @@ -101634,10 +110896,6 @@ export interface operations { }; }; }; - /** - * List deployments - * @description Simple filtering of deployments is available via query parameters: - */ "repos/list-deployments": { parameters: { query?: { @@ -101648,20 +110906,28 @@ export interface operations { /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment"][]; @@ -101669,63 +110935,17 @@ export interface operations { }; }; }; - /** - * Create a deployment - * @description Deployments offer a few configurable parameters with certain defaults. - * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Cloud we often deploy branches and verify them - * before we merge a pull request. - * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. - * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. - * - * By default, [commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. - * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. - * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. - * - * Merged branch response: - * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts - * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. - * - * Merge conflict response: - * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * Failed commit status checks: - * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -101744,14 +110964,11 @@ export interface operations { auto_merge?: boolean; /** @description The [status](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; - payload?: OneOf< - [ - { + payload?: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production @@ -101775,12 +110992,18 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -101789,23 +111012,35 @@ export interface operations { }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** Get a deployment */ "repos/get-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; @@ -101813,57 +111048,59 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * To set a deployment as inactive, you must: - * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. - * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/delete-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List deployment statuses - * @description Users with pull access can view deployment statuses for a deployment: - */ "repos/list-deployment-statuses": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"][]; @@ -101872,19 +111109,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a deployment status - * @description Users with `push` access can create deployment statuses for a given deployment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -101934,6 +111171,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"]; @@ -101942,22 +111180,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a deployment status - * @description Users with pull access can view a deployment status for a deployment: - */ "repos/get-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; status_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-status"]; }; @@ -101965,22 +111209,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Cloud to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#repository_dispatch)." - * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-dispatch-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -101997,34 +111236,39 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List environments - * @description Lists the environments for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -102038,48 +111282,46 @@ export interface operations { }; }; }; - /** - * Get an environment - * @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)." - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; }; }; - /** - * Create or update an environment - * @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)." - * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-or-update-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102104,60 +111346,75 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Delete an environment - * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-an-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List deployment branch policies - * @description Lists the deployment branch policies for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-deployment-branch-policies": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -102171,19 +111428,19 @@ export interface operations { }; }; }; - /** - * Create a deployment branch policy - * @description Creates a deployment branch or tag policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -102193,60 +111450,73 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ 303: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a deployment branch policy - * @description Gets a deployment branch or tag policy for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Update a deployment branch policy - * @description Updates a deployment branch or tag policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -102256,53 +111526,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Delete a deployment branch policy - * @description Deletes a deployment branch or tag policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-deployment-protection-rules": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of deployment protection rules */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -102316,23 +111596,19 @@ export interface operations { }; }; }; - /** - * Create a custom deployment protection rule on an environment - * @description Enable a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; requestBody: { content: { @@ -102345,37 +111621,41 @@ export interface operations { responses: { /** @description The enabled custom deployment protection rule */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. - * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)". - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-custom-deployment-rule-integrations": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A list of custom deployment rule integrations available for this environment. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -102389,82 +111669,88 @@ export interface operations { }; }; }; - /** - * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-custom-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * Disable a custom protection rule for an environment - * @description Disables a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/disable-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -102475,75 +111761,77 @@ export interface operations { }; }; }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -102558,65 +111846,75 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -102627,21 +111925,19 @@ export interface operations { }; }; }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -102656,78 +111952,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -102742,53 +112046,69 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - */ "activity/list-repo-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List forks */ "repos/list-forks": { parameters: { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -102797,20 +112117,17 @@ export interface operations { 400: components["responses"]["bad_request"]; }; }; - /** - * Create a fork - * @description Create a fork for the authenticated user. - * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). - * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. - */ "repos/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102827,6 +112144,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -102837,13 +112157,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Create a blob */ "git/create-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -102864,6 +112188,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-blob"]; @@ -102875,28 +112200,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a blob - * @description The `content` in the response will always be Base64 encoded. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. - * - * **Note** This endpoint supports blobs up to 100 megabytes in size. - */ "git/get-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; file_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["blob"]; }; @@ -102907,45 +112230,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a commit - * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -102991,6 +112286,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-commit"]; @@ -103001,52 +112297,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a commit object - * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-commit"]; }; @@ -103055,29 +112326,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List matching references - * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - */ "git/list-matching-refs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"][]; @@ -103086,23 +112358,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a reference - * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - */ "git/get-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -103111,16 +112390,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a reference - * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. - */ "git/create-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -103138,6 +112418,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"]; @@ -103147,38 +112428,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a reference - * @description Deletes the provided reference. - */ "git/delete-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a reference - * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - */ "git/update-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; requestBody: { content: { @@ -103196,6 +112491,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -103204,45 +112502,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -103279,6 +112549,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tag"]; @@ -103288,48 +112559,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tag - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; tag_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tag"]; }; @@ -103338,20 +112587,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a tree - * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference)." - * - * Returns an error if you try to delete a file that does not exist. - */ "git/create-tree": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -103370,23 +112616,18 @@ export interface operations { * @enum {string} */ type?: "blob" | "tree" | "commit"; - /** - * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + /** @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ sha?: string | null; - /** - * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + /** @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ content?: string; }[]; - /** - * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - */ + /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + * */ base_tree?: string; }; }; @@ -103397,6 +112638,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tree"]; @@ -103408,31 +112650,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tree - * @description Returns a single tree using the SHA1 value or ref name for that tree. - * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. - */ "git/get-tree": { parameters: { query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ recursive?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tree"]; }; @@ -103442,26 +112683,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository webhooks - * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. - */ "repos/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"][]; @@ -103470,17 +112715,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository webhook - * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. - */ "repos/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -103497,8 +112742,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -103515,6 +112760,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"]; @@ -103525,21 +112771,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." - */ "repos/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -103547,34 +112799,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ "repos/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." - */ "repos/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -103583,8 +112846,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ @@ -103602,6 +112865,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -103610,42 +112876,46 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. - */ "repos/get-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. - */ "repos/update-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -103660,32 +112930,42 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for a repository webhook - * @description Returns a list of webhook deliveries for a webhook configured in a repository. - */ "repos/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -103694,22 +112974,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for a repository webhook - * @description Returns a delivery for a webhook configured in a repository. - */ "repos/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -103718,117 +113004,99 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for a repository webhook - * @description Redeliver a webhook delivery for a webhook configured in a repository. - */ "repos/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook. - */ "repos/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Test the push repository webhook - * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - */ "repos/test-push-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an import status - * @deprecated - * @description View the progress of an import. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * - * **Import status** - * - * This section includes details about the possible values of the `status` field of the Import Progress response. - * - * An import that does not have errors will progress through these steps: - * - * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. - * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). - * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. - * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". - * * `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud. - * - * If there are problems, you will see one of these in the `status` field: - * - * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. - * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. - * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. - * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL. - * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section. - * - * **The project_choices field** - * - * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. - * - * **Git LFS related fields** - * - * This section includes details about Git LFS related fields that may be present in the Import Progress response. - * - * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. - * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. - * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. - * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. - */ "migrations/get-import-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["import"]; }; @@ -103837,21 +113105,17 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Start an import - * @deprecated - * @description Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. - * Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will - * return a status `422 Unprocessable Entity` response. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/start-import": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -103878,6 +113142,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/spraints/socm/import */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["import"]; @@ -103888,46 +113153,41 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Cancel an import - * @deprecated - * @description Stop an import for a repository. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/cancel-import": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Update an import - * @deprecated - * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API - * request. If no parameters are provided, the import will be restarted. - * - * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will - * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. - * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/update-import": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -103953,6 +113213,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["import"]; }; @@ -103960,28 +113223,28 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Get commit authors - * @deprecated - * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. - * - * This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/get-commit-authors": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["porter-author"][]; }; @@ -103990,21 +113253,18 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Map a commit author - * @deprecated - * @description Update an author's identity for the import. Your application can continue updating authors any time before you push - * new commits to the repository. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/map-commit-author": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; author_id: number; }; + cookie?: never; }; requestBody?: { content: { @@ -104019,6 +113279,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["porter-author"]; }; @@ -104028,23 +113291,25 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Get large files - * @deprecated - * @description List files larger than 100MB found during the import - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/get-large-files": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["porter-large-file"][]; }; @@ -104052,23 +113317,17 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Update Git LFS preference - * @deprecated - * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability - * is powered by [Git LFS](https://git-lfs.com). - * - * You can learn more about our LFS feature and working with large files [on our help - * site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/set-lfs-preference": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104084,6 +113343,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["import"]; }; @@ -104092,22 +113354,25 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Get a repository installation for the authenticated app - * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-repo-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -104116,20 +113381,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get interaction restrictions for a repository - * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. - */ "interactions/get-restrictions-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["interaction-limit-response"] @@ -104138,16 +113408,17 @@ export interface operations { }; }; }; - /** - * Set interaction restrictions for a repository - * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. - */ "interactions/set-restrictions-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104157,58 +113428,76 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["interaction-limit-response"]; }; }; /** @description Response */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove interaction restrictions for a repository - * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. - */ "interactions/remove-restrictions-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository invitations - * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. - */ "repos/list-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -104216,30 +113505,44 @@ export interface operations { }; }; }; - /** Delete a repository invitation */ "repos/delete-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a repository invitation */ "repos/update-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -104255,28 +113558,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - /** - * List repository issues - * @description List issues in a repository. Only open issues will be listed. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-repo": { parameters: { query?: { @@ -104290,24 +113580,35 @@ export interface operations { creator?: string; /** @description A user that's mentioned in the issue. */ mentioned?: string; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -104318,26 +113619,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-cloud@latest//articles/disabling-issues/), the API returns a `410 Gone` status. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104348,19 +113640,17 @@ export interface operations { body?: string; /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ assignee?: string | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; }; @@ -104372,6 +113662,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"]; @@ -104385,39 +113676,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List issue comments for a repository - * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. - * - * By default, issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments-for-repo": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -104427,28 +113715,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue comment - * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -104456,43 +113743,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an issue comment - * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - */ "issues/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an issue comment - * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -104505,6 +113793,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -104512,10 +113803,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). - */ "reactions/list-for-issue-comment": { parameters: { query?: { @@ -104529,20 +113816,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -104551,17 +113847,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. - */ "reactions/create-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -104585,12 +113883,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -104598,48 +113902,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment). - */ "reactions/delete-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List issue events for a repository - * @description Lists events for a repository. - */ "issues/list-events-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event"][]; @@ -104648,21 +113961,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue event - * @description Gets a single event by the event id. - */ "issues/get-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; event_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-event"]; }; @@ -104672,38 +113990,27 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-cloud@latest//articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-cloud@latest//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 - * 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/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -104714,30 +114021,25 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update an issue - * @description Issue owners and users with push access can edit an issue. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** @description The title of the issue. */ - title?: string | number | null; + title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; /** @description Username to assign to this issue. **This field is deprecated.** */ @@ -104753,19 +114055,17 @@ export interface operations { * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; }; @@ -104774,6 +114074,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -104786,17 +114089,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Add assignees to an issue - * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - */ "issues/add-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -104809,23 +114114,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Remove assignees from an issue - * @description Removes one or more assignees from an issue. - */ "issues/remove-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -104838,73 +114148,78 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Check if a user can be assigned to a issue - * @description 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. - */ "issues/check-user-can-be-assigned-to-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List issue comments - * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * Issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -104914,29 +114229,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create an issue comment - * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -104952,6 +114257,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"]; @@ -104963,27 +114269,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List issue events - * @description Lists all events for an issue. - */ "issues/list-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event-for-issue"][]; @@ -104992,27 +114303,32 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * List labels for an issue - * @description Lists all labels for an issue. - */ "issues/list-labels-on-issue": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -105023,38 +114339,40 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Set labels for an issue - * @description Removes any previous labels and sets the new labels for an issue. - */ "issues/set-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -105065,38 +114383,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. - */ "issues/add-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -105107,44 +114427,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all labels from an issue - * @description Removes all labels from an issue. - */ "issues/remove-all-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 301: components["responses"]["moved_permanently"]; 404: components["responses"]["not_found"]; 410: components["responses"]["gone"]; }; }; - /** - * Remove a label from an issue - * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. - */ "issues/remove-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -105154,29 +114486,29 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Lock an issue - * @description Users with push access can lock an issue or pull request's conversation. - * - * 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - */ "issues/lock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` * @enum {string} */ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; @@ -105186,7 +114518,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -105194,31 +114529,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unlock an issue - * @description Users with push access can unlock an issue's conversation. - */ "issues/unlock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). - */ "reactions/list-for-issue": { parameters: { query?: { @@ -105232,20 +114569,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -105255,17 +114601,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. - */ "reactions/create-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -105289,12 +114637,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -105302,49 +114656,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue). - */ "reactions/delete-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List timeline events for an issue - * @description List all timeline events for an issue. - */ "issues/list-events-for-timeline": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["timeline-issue-events"][]; @@ -105354,23 +114718,30 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** List deploy keys */ "repos/list-deploy-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"][]; @@ -105378,16 +114749,17 @@ export interface operations { }; }; }; - /** - * Create a deploy key - * @description You can create a read-only deploy key. - */ "repos/create-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -105396,11 +114768,9 @@ export interface operations { title?: string; /** @description The contents of the key. */ key: string; - /** - * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + /** @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/)." - */ + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-cloud@latest//articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-cloud@latest//articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; }; @@ -105411,6 +114781,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"]; @@ -105419,18 +114790,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get a deploy key */ "repos/get-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deploy-key"]; }; @@ -105438,45 +114818,55 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a deploy key - * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. - */ "repos/delete-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a repository - * @description Lists all labels for a repository. - */ "issues/list-labels-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -105485,16 +114875,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a label - * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). - */ "issues/create-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -105514,6 +114905,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"]; @@ -105523,21 +114915,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a label - * @description Gets a label using the given name. - */ "issues/get-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; @@ -105545,36 +114942,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a label - * @description Deletes a label using the given label name. - */ "issues/delete-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a label - * @description Updates a label using the given label name. - */ "issues/update-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; requestBody?: { content: { @@ -105591,101 +114994,113 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; }; }; }; - /** - * List repository languages - * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. - */ "repos/list-languages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["language"]; }; }; }; }; - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/enable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; - /** - * @description We will return a 403 with one of the following messages: + /** @description We will return a 403 with one of the following messages: * - * - Git LFS support not enabled because Git LFS is globally disabled. - * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - * - Git LFS support not enabled because Git LFS is disabled for . - */ + * - Git LFS support not enabled because Git LFS is globally disabled. + * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + * - Git LFS support not enabled because Git LFS is disabled for . */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/disable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the license for a repository - * @description This method returns the contents of the repository's license file, if one is detected. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "licenses/get-for-repo": { parameters: { query?: { + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-content"]; }; @@ -105693,16 +115108,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Sync a fork branch with the upstream repository - * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. - */ "repos/merge-upstream": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -105715,27 +115131,40 @@ export interface operations { responses: { /** @description The branch has been successfully synced with the upstream repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The branch could not be synced for some other reason */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Merge a branch */ "repos/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -105752,30 +115181,38 @@ export interface operations { responses: { /** @description Successful Response (The resulting merge commit) */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when there is a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * List milestones - * @description Lists milestones for a repository. - */ "issues/list-milestones": { parameters: { query?: { @@ -105785,19 +115222,27 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"][]; @@ -105806,16 +115251,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a milestone - * @description Creates a milestone. - */ "issues/create-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -105844,6 +115290,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"]; @@ -105853,21 +115300,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a milestone - * @description Gets a milestone using the given milestone number. - */ "issues/get-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; @@ -105875,34 +115328,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a milestone - * @description Deletes a milestone using the given milestone number. - */ "issues/delete-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** Update a milestone */ "issues/update-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -105928,33 +115392,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; }; }; }; - /** - * List labels for issues in a milestone - * @description Lists labels for issues in a milestone. - */ "issues/list-labels-for-milestone": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -105962,30 +115434,38 @@ export interface operations { }; }; }; - /** - * List repository notifications for the authenticated user - * @description Lists all notifications for the current user in the specified repository. - */ "activity/list-repo-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -105993,16 +115473,17 @@ export interface operations { }; }; }; - /** - * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Cloud 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/enterprise-cloud@latest//rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-repo-notifications-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -106018,6 +115499,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -106027,26 +115511,32 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a GitHub Enterprise Cloud Pages site - * @description Gets information about a GitHub Enterprise Cloud Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -106054,99 +115544,111 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update information about a GitHub Enterprise Cloud Pages site - * @description Updates information for a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-information-about-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @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. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: - | ("gh-pages" | "master" | "master /docs") - | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - /** @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. */ - public?: boolean; - }; + "application/json": + | { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-cloud@latest//articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @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. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: + | ("gh-pages" | "master" | "master /docs") + | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + /** @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. */ + public?: boolean; + } + | unknown + | unknown + | unknown + | unknown + | unknown; }; }; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["bad_request"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a GitHub Enterprise Cloud Pages site - * @description Configures a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } | null; + "application/json": + | ( + | { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } + | unknown + | unknown + ) + | null; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -106155,53 +115657,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a GitHub Enterprise Cloud Pages site - * @description Deletes a GitHub Enterprise Cloud Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List GitHub Enterprise Cloud Pages builds - * @description Lists builts of a GitHub Enterprise Cloud Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/list-pages-builds": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["page-build"][]; @@ -106209,85 +115714,93 @@ export interface operations { }; }; }; - /** - * Request a GitHub Enterprise Cloud Pages build - * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - */ "repos/request-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - /** - * Get latest Pages build - * @description Gets information about the single most recent build of a GitHub Enterprise Cloud Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-latest-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Get GitHub Enterprise Cloud Pages build - * @description Gets information about a GitHub Enterprise Cloud Pages build. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; build_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Create a GitHub Pages deployment - * @description Create a GitHub Pages deployment for a repository. - * - * The authenticated user must have write permission to the repository. - */ "repos/create-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -106314,6 +115827,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-deployment"]; }; @@ -106323,23 +115839,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the status of a GitHub Pages deployment - * @description Gets the current status of a GitHub Pages deployment. - * - * The authenticated user must have read permission for the GitHub Pages site. - */ "repos/get-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pages-deployment-status"]; }; @@ -106347,80 +115867,94 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Cancel a GitHub Pages deployment - * @description Cancels a GitHub Pages deployment. - * - * The authenticated user must have write permissions for the GitHub Pages site. - */ "repos/cancel-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a DNS health check for GitHub Pages - * @description Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. - * - * 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. - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages-health-check": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pages-health-check"]; }; }; /** @description Empty response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Custom domains are not available for GitHub Pages */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description There isn't a CNAME for this page */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Check if private vulnerability reporting is enabled for a repository - * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". - */ "repos/check-private-vulnerability-reporting": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Private vulnerability reporting status */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description Whether or not private vulnerability reporting is enabled for the repository. */ @@ -106431,60 +115965,68 @@ export interface operations { 422: components["responses"]["bad_request"]; }; }; - /** - * Enable private vulnerability reporting for a repository - * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." - */ "repos/enable-private-vulnerability-reporting": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 422: components["responses"]["bad_request"]; }; }; - /** - * Disable private vulnerability reporting for a repository - * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". - */ "repos/disable-private-vulnerability-reporting": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 422: components["responses"]["bad_request"]; }; }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-repo": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -106497,16 +116039,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -106521,6 +116064,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -106532,21 +116078,25 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get all custom property values for a repository - * @description Gets all custom property values that are set for a repository. - * Users with read access to the repository can use this endpoint. - */ "repos/get-custom-properties-values": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["custom-property-value"][]; }; @@ -106555,19 +116105,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update custom property values for a repository - * @description Create new or update existing custom property values for a repository. - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - * - * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. - */ "repos/create-or-update-custom-properties-values": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -106580,30 +116128,16 @@ export interface operations { responses: { /** @description No Content when custom property values are successfully created or updated */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests - * @description Lists pull requests in a specified repository. - * - * 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/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list": { parameters: { query?: { @@ -106617,19 +116151,27 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -106639,27 +116181,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -106697,6 +116229,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request"]; @@ -106706,38 +116239,35 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments-for-repo": { parameters: { query?: { sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -106745,28 +116275,27 @@ export interface operations { }; }; }; - /** - * Get a review comment for a pull request - * @description Provides details for a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; @@ -106774,44 +116303,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a review comment for a pull request - * @description Deletes a review comment. - */ "pulls/delete-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a review comment for a pull request - * @description Edits the content of a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -106824,16 +116354,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - /** - * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { @@ -106847,20 +116376,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -106869,17 +116407,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. - */ "reactions/create-for-pull-request-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -106903,12 +116443,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -106916,65 +116462,54 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/delete-for-pull-request-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Get a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists details of a pull request by providing its number. - * - * When you get, [create](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Cloud creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Cloud has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * - * * If merged as a [merge commit](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-cloud@latest//articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - * - * Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "pulls/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -106986,26 +116521,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -107029,6 +116557,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -107037,19 +116568,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a codespace from a pull request - * @description Creates a codespace owned by the authenticated user for the specified pull request. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/create-with-pr-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -107083,12 +116614,18 @@ export interface operations { responses: { /** @description Response when the codespace was successfully created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -107099,39 +116636,38 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List review comments on a pull request - * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -107139,31 +116675,19 @@ export interface operations { }; }; }; - /** - * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment)." - * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -107212,6 +116736,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -107221,28 +116746,21 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a reply for a review comment - * @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. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-reply-for-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -107258,6 +116776,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -107266,36 +116785,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits) - * endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -107303,37 +116818,32 @@ export interface operations { }; }; }; - /** - * List pull requests files - * @description Lists the files in a specified pull request. - * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-files": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["diff-entry"][]; @@ -107344,41 +116854,51 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Check if a pull request has been merged - * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. - */ "pulls/check-if-merged": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if pull request has been merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if pull request has not been merged */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Merge a pull request - * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - */ "pulls/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -107400,6 +116920,9 @@ export interface operations { responses: { /** @description if merge was successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-merge-result"]; }; @@ -107408,6 +116931,9 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ 405: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -107417,6 +116943,9 @@ export interface operations { }; /** @description Conflict if sha was provided and pull request head did not match */ 409: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -107427,23 +116956,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request) operation. - */ "pulls/list-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-request"]; @@ -107451,17 +116984,19 @@ export interface operations { }; }; }; - /** - * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - */ "pulls/request-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -107476,6 +117011,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -107483,21 +117021,26 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove requested reviewers from a pull request - * @description Removes review requests from a pull request for a given set of users and/or teams. - */ "pulls/remove-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -107512,6 +117055,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -107519,34 +117065,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reviews for a pull request - * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-reviews": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The list of reviews returns in chronological order. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review"][]; @@ -107554,32 +117098,19 @@ export interface operations { }; }; }; - /** - * Create a review for a pull request - * @description Creates a review on a specified pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * 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/enterprise-cloud@latest//rest/pulls/reviews#submit-a-review-for-a-pull-request)." - * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request) endpoint. - * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -107616,6 +117147,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -107624,29 +117158,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a review for a pull request - * @description Retrieves a pull request review by its ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -107654,25 +117188,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a review for a pull request - * @description Updates the contents of a specified review summary comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -107685,6 +117215,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -107692,29 +117225,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete a pending review for a pull request - * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/delete-pending-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -107723,35 +117256,34 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List comments for a pull request review - * @description Lists comments for a specific pull request review. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-comments-for-review": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["review-comment"][]; @@ -107760,29 +117292,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Dismiss a review for a pull request - * @description Dismisses a specified review on a pull request. - * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/dismiss-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -107800,6 +117324,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -107808,25 +117335,21 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#create-a-review-for-a-pull-request)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/submit-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -107844,6 +117367,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -107853,17 +117379,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Update a pull request branch - * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - */ "pulls/update-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -107876,6 +117404,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -107887,29 +117418,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README - * @description Gets the preferred README for a repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -107918,31 +117448,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README for a directory - * @description Gets the README from a repository directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme-in-directory": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ dir: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -107951,28 +117480,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags). - * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - */ "repos/list-releases": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"][]; @@ -107981,18 +117512,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a release - * @description Users with push access to the repository can create a release. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - */ "repos/create-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -108037,6 +117567,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"]; @@ -108044,6 +117575,9 @@ export interface operations { }; /** @description Not Found if the discussion category name is invalid */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -108051,21 +117585,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. - */ "repos/get-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; @@ -108074,33 +117614,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a release asset */ "repos/delete-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release asset - * @description Users with push access to the repository can edit a release asset. - */ "repos/update-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -108117,22 +117668,26 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; }; }; - /** - * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. - */ "repos/generate-release-notes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -108151,6 +117706,9 @@ export interface operations { responses: { /** @description Name and body of generated release notes */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-notes-content"]; }; @@ -108158,44 +117716,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the latest release - * @description View the latest published full release for the repository. - * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - */ "repos/get-latest-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** - * Get a release by tag name - * @description Get a published release with the specified tag. - */ "repos/get-release-by-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description tag parameter */ tag: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; @@ -108203,65 +117769,78 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a release - * @description Gets a public release with the specified release ID. - * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - */ "repos/get-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a release - * @description Users with push access to the repository can delete a release. - */ "repos/delete-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release - * @description Users with push access to the repository can edit a release. - */ "repos/update-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -108292,36 +117871,50 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Not Found if the discussion category name is invalid */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** List release assets */ "repos/list-release-assets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release-asset"][]; @@ -108329,39 +117922,22 @@ export interface operations { }; }; }; - /** - * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release) to upload a release asset. - * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - * - * `application/zip` - * - * GitHub Enterprise Cloud expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. - * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. - * - * **Notes:** - * * GitHub Enterprise Cloud renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. - */ "repos/upload-release-asset": { parameters: { query: { name: string; label?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -108371,39 +117947,50 @@ export interface operations { responses: { /** @description Response for successful upload */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). - */ "reactions/list-for-release": { parameters: { query?: { /** @description Returns a single [reaction type](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -108412,17 +117999,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. - */ "reactions/create-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -108438,12 +118027,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -108451,76 +118046,91 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - * - * Delete a reaction to a [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release). - */ "reactions/delete-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get rules for a branch - * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply - * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level - * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" - * enforcement statuses are not returned. - */ "repos/get-branch-rules": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-cloud@latest//graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-rule-detailed"][]; }; }; }; }; - /** - * Get all repository rulesets - * @description Get all the rulesets for a repository. - */ "repos/get-repo-rulesets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"][]; }; @@ -108529,16 +118139,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a repository ruleset - * @description Create a ruleset for a repository. - */ "repos/create-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; /** @description Request body */ requestBody: { @@ -108549,7 +118160,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -108565,6 +118176,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -108573,29 +118187,40 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repository rule suites - * @description Lists suites of rule evaluations at the repository level. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." - */ "repos/get-repo-rule-suites": { parameters: { query?: { + /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; + /** @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suites"]; }; @@ -108604,22 +118229,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get a repository rule suite - * @description Gets information about a suite of rule evaluations from within a repository. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." - */ "repos/get-repo-rule-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. */ rule_suite_id: components["parameters"]["rule-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suite"]; }; @@ -108628,26 +118261,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get a repository ruleset - * @description Get a ruleset for a repository. - */ "repos/get-repo-ruleset": { parameters: { query?: { /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -108656,18 +118293,19 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update a repository ruleset - * @description Update a ruleset for a repository. - */ "repos/update-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; /** @description Request body */ requestBody?: { @@ -108678,7 +118316,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -108694,6 +118332,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -108702,88 +118343,110 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete a repository ruleset - * @description Delete a ruleset for a repository. - */ "repos/delete-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List secret scanning alerts for a repository - * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a secret scanning alert - * @description Gets a single secret scanning alert detected in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; @@ -108791,26 +118454,27 @@ export interface operations { 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a secret scanning alert - * @description Updates the status of a secret scanning alert in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -108824,50 +118488,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description State does not match the resolution or resolution comment */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List locations for a secret scanning alert - * @description Lists all locations for a given secret scanning alert for an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-locations-for-alert": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["secret-scanning-location"][]; @@ -108875,40 +118552,46 @@ export interface operations { }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository security advisories - * @description Lists security advisories in a repository. - * - * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. - */ "security-advisories/list-repository-advisories": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description Filter by state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"][]; }; @@ -108917,20 +118600,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository security advisory - * @description Creates a new repository security advisory. - * - * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/create-repository-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -108940,6 +118620,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -108949,17 +118632,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Privately report a security vulnerability - * @description Report a security vulnerability to the maintainers of the repository. - * See "[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. - */ "security-advisories/create-private-vulnerability-report": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -108969,6 +118652,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -108978,28 +118664,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository security advisory - * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * - * Anyone can access any published security advisory on a public repository. - * - * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a - * collaborator on the security advisory. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. - */ "security-advisories/get-repository-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -109008,22 +118693,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository security advisory - * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * - * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, - * or a collaborator on the repository security advisory. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/update-repository-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; requestBody: { content: { @@ -109033,6 +118715,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -109041,30 +118726,30 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation failed, or the endpoint has been spammed. */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; }; }; - /** - * Request a CVE for a repository security advisory - * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." - * - * You may request a CVE for public repositories, but cannot do so for private repositories. - * - * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/create-repository-advisory-cve-request": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; @@ -109073,23 +118758,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a temporary private fork - * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. - * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. - */ "security-advisories/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -109100,30 +118789,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List stargazers - * @description Lists the people that have starred the repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-stargazers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -109134,24 +118823,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. - */ "repos/get-code-frequency-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -109160,24 +118850,32 @@ export interface operations { 204: components["responses"]["no_content"]; /** @description Repository contains more than 10,000 commits */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the last year of commit activity - * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. - */ "repos/get-commit-activity-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-activity"][]; }; @@ -109186,28 +118884,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get all contributor commit activity - * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits - * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. - */ "repos/get-contributors-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["contributor-activity"][]; }; @@ -109216,24 +118911,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the weekly commit count - * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - * - * The array order is oldest week (index 0) to most recent week. - * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. - */ "repos/get-participation-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The array order is oldest week (index 0) to most recent week. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["participation-stats"]; }; @@ -109241,26 +118937,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the hourly commit count for each day - * @description Each array contains the day number, hour number, and number of commits: - * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits - * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - */ "repos/get-punch-card-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -109268,19 +118963,18 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Create a commit status - * @description Users with push access in a repository can create commit statuses for a given SHA. - * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - */ "repos/create-commit-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; sha: string; }; + cookie?: never; }; requestBody: { content: { @@ -109290,11 +118984,9 @@ export interface operations { * @enum {string} */ state: "error" | "failure" | "pending" | "success"; - /** - * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. - * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: - * `http://ci.example.com/user/repo/build/sha` - */ + /** @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; /** @description A short description of the status. */ description?: string | null; @@ -109312,6 +119004,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"]; @@ -109319,26 +119012,30 @@ export interface operations { }; }; }; - /** - * List watchers - * @description Lists the people watching the specified repository. - */ "activity/list-watchers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -109346,20 +119043,25 @@ export interface operations { }; }; }; - /** - * Get a repository subscription - * @description Gets information about whether the authenticated user is subscribed to the repository. - */ "activity/get-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if you subscribe to the repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; @@ -109367,20 +119069,24 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription) completely. - */ "activity/set-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -109395,47 +119101,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - /** - * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription). - */ "activity/delete-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List repository tags */ "repos/list-tags": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["tag"][]; @@ -109443,22 +119164,25 @@ export interface operations { }; }; }; - /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ "repos/list-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"][]; }; @@ -109467,17 +119191,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/create-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -109490,6 +119214,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"]; }; @@ -109498,78 +119225,83 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/delete-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the tag protection. */ tag_protection_id: components["parameters"]["tag-protection-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Download a repository archive (tar) - * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. - */ "repos/download-tarball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * List repository teams - * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. - * - * For a public repository, a team is listed only if that team added the public repository explicitly. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. - */ "repos/list-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -109578,21 +119310,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get all repository topics */ "repos/get-all-topics": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -109600,13 +119341,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Replace all repository topics */ "repos/replace-all-topics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -109619,6 +119364,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -109627,23 +119375,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get repository clones - * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. - */ "repos/get-clones": { parameters: { query?: { + /** @description The time frame to display results for. */ per?: components["parameters"]["per"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["clone-traffic"]; }; @@ -109651,20 +119404,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get top referral paths - * @description Get the top 10 popular contents over the last 14 days. - */ "repos/get-top-paths": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-traffic"][]; }; @@ -109672,20 +119430,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get top referral sources - * @description Get the top 10 referrers over the last 14 days. - */ "repos/get-top-referrers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["referrer-traffic"][]; }; @@ -109693,23 +119456,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get page views - * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. - */ "repos/get-views": { parameters: { query?: { + /** @description The time frame to display results for. */ per?: components["parameters"]["per"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["view-traffic"]; }; @@ -109717,16 +119485,17 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-cloud@latest//articles/about-repository-transfers/). - */ "repos/transfer": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -109743,113 +119512,128 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - /** - * Check if vulnerability alerts are enabled for a repository - * @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/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/check-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if repository is enabled with vulnerability alerts */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not enabled with vulnerability alerts */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable vulnerability alerts - * @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/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/enable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable vulnerability alerts - * @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/enterprise-cloud@latest//articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/disable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download a repository archive (zip) - * @description 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 - * 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. - */ "repos/download-zipball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-using-template": { parameters: { + query?: never; + header?: never; path: { /** @description The account owner of the template repository. The name is not case sensitive. */ template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ template_repo: string; }; + cookie?: never; }; requestBody: { content: { @@ -109879,6 +119663,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -109886,26 +119671,24 @@ export interface operations { }; }; }; - /** - * List public repositories - * @description Lists all public repositories in the order that they were created. - * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. - */ "repos/list-public": { parameters: { query?: { + /** @description A repository ID. Only return repositories with an ID greater than this ID. */ since?: components["parameters"]["since-repo"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -109915,30 +119698,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List provisioned SCIM groups for an enterprise - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Lists provisioned SCIM groups in an enterprise. - * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. - */ "enterprise-admin/list-provisioned-groups-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either groups were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-list"]; }; @@ -109950,19 +119735,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Creates a SCIM group for an enterprise. - * - * When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the `externalId` and `id` for each user. - */ "enterprise-admin/provision-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -109972,6 +119753,9 @@ export interface operations { responses: { /** @description Group has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -109984,25 +119768,28 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Gets information about a SCIM group. - */ "enterprise-admin/get-provisioning-information-for-enterprise-group": { parameters: { query?: { + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; }; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a group was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -110015,20 +119802,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Replaces an existing provisioned group’s information. - * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. - */ "enterprise-admin/set-information-for-provisioned-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -110038,6 +119822,9 @@ export interface operations { responses: { /** @description Group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -110051,23 +119838,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM group from an enterprise - * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. - * - * Deletes a SCIM group from an enterprise. - */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Group was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -110077,24 +119867,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise group - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Update a provisioned group’s individual attributes. - * - * To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). The update function can also be used to add group memberships. - * - * You can submit group memberships individually or in batches for improved efficiency. - * - * **Note**: Memberships are referenced via a local user id. Ensure users are created before referencing them here. - */ "enterprise-admin/update-attribute-for-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -110104,13 +119887,19 @@ export interface operations { responses: { /** @description Success, group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; }; /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -110121,29 +119910,30 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * List SCIM provisioned identities for an enterprise - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Lists provisioned SCIM enterprise members. - * - * When you remove a user with a SCIM-provisioned external identity from an enterprise using a `patch` with `active` flag to `false`, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list. - */ "enterprise-admin/list-provisioned-identities-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either users were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-list"]; }; @@ -110155,19 +119945,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Creates an external identity for a new SCIM enterprise user. - * - * SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML. - */ "enterprise-admin/provision-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -110177,6 +119963,9 @@ export interface operations { responses: { /** @description User has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -110189,22 +119978,25 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Gets information about a SCIM user. - */ "enterprise-admin/get-provisioning-information-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a user was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -110217,22 +120009,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Replaces an existing provisioned user's information. - * - * You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint. - * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. - */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -110242,6 +120029,9 @@ export interface operations { responses: { /** @description User was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -110255,23 +120045,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM user from an enterprise - * @description **Note:** SCIM provisioning using the REST API is in public beta and subject to change. - * - * Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible. - */ "enterprise-admin/delete-user-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description User was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -110281,35 +120074,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise user - * @description **Note:** SCIM provisioning for users and groups using the REST API is in public beta and subject to change. - * - * Update a provisioned user's individual attributes. - * - * To modify a user's attributes, you'll need to provide a `Operations` JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). - * - * **Note:** Complex SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will be ineffective. - * - * **Warning:** Setting `active: false` will suspend a user, and their handle and email will be obfuscated. - * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` - */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -110319,6 +120094,9 @@ export interface operations { responses: { /** @description Success, user was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -110332,25 +120110,6 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * List SCIM provisioned identities - * @description Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the `filter` parameter, the resources for all matching provisions members are returned. - * - * When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub Enterprise Cloud. This can happen in certain cases where an external identity associated with an organization will not match an organization member: - * - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. - * - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). - * - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO. - * - * The returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub Enterprise Cloud account after completing SSO: - * - * 1. The user is granted access by the IdP and is not a member of the GitHub Enterprise Cloud organization. - * - * 1. The user attempts to access the GitHub Enterprise Cloud organization and initiates the SAML SSO process, and is not currently signed in to their GitHub Enterprise Cloud account. - * - * 1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub Enterprise Cloud account: - * - If the user signs in, their GitHub Enterprise Cloud account is linked to this entry. - * - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub Enterprise Cloud organization, and the external identity `null` entry remains in place. - */ "scim/list-provisioned-identities": { parameters: { query?: { @@ -110358,24 +120117,29 @@ export interface operations { startIndex?: number; /** @description Used for pagination: the number of results to return. */ count?: number; - /** - * @description Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `externalId`. For example, to search for an identity with the `userName` Octocat, you would use this query: + /** @description Filters results using the equals query parameter operator (`eq`). You can filter results that are equal to `id`, `userName`, `emails`, and `externalId`. For example, to search for an identity with the `userName` Octocat, you would use this query: * - * `?filter=userName%20eq%20\"Octocat\"`. + * `?filter=userName%20eq%20\"Octocat\"`. * - * To filter results for the identity with the email `octocat@github.com`, you would use this query: + * To filter results for the identity with the email `octocat@github.com`, you would use this query: * - * `?filter=emails%20eq%20\"octocat@github.com\"`. - */ + * `?filter=emails%20eq%20\"octocat@github.com\"`. */ filter?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-user-list"]; }; @@ -110387,15 +120151,15 @@ export interface operations { 429: components["responses"]["scim_too_many_requests"]; }; }; - /** - * Provision and invite a SCIM user - * @description Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see "[Reinstating a former member of your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-membership-in-your-organization/reinstating-a-former-member-of-your-organization)." - */ "scim/provision-and-invite-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -110410,12 +120174,10 @@ export interface operations { * @example Jon Doe */ displayName?: string; - /** - * @example { - * "givenName": "Jane", - * "familyName": "User" - * } - */ + /** @example { + * "givenName": "Jane", + * "familyName": "User" + * } */ name: { givenName: string; familyName: string; @@ -110424,15 +120186,15 @@ export interface operations { /** * @description user emails * @example [ - * { - * "value": "someone@example.com", - * "primary": true - * }, - * { - * "value": "another@example.com", - * "primary": false - * } - * ] + * { + * "value": "someone@example.com", + * "primary": true + * }, + * { + * "value": "another@example.com", + * "primary": false + * } + * ] */ emails: { value: string; @@ -110449,6 +120211,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-user"]; }; @@ -110461,17 +120226,25 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** Get SCIM provisioning information for a user */ "scim/get-provisioning-information-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-user"]; }; @@ -110481,20 +120254,17 @@ export interface operations { 404: components["responses"]["scim_not_found"]; }; }; - /** - * Update a provisioned organization membership - * @description Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-an-attribute-for-a-scim-user) endpoint instead. - * - * You must at least provide the required values for the user: `userName`, `name`, and `emails`. - * - * **Warning:** Setting `active: false` removes the user from the organization, deletes the external identity, and deletes the associated `{scim_user_id}`. - */ "scim/set-information-for-provisioned-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -110513,12 +120283,10 @@ export interface operations { * @example someone@example.com */ userName: string; - /** - * @example { - * "givenName": "Jane", - * "familyName": "User" - * } - */ + /** @example { + * "givenName": "Jane", + * "familyName": "User" + * } */ name: { givenName: string; familyName: string; @@ -110527,15 +120295,15 @@ export interface operations { /** * @description user emails * @example [ - * { - * "value": "someone@example.com", - * "primary": true - * }, - * { - * "value": "another@example.com", - * "primary": false - * } - * ] + * { + * "value": "someone@example.com", + * "primary": true + * }, + * { + * "value": "another@example.com", + * "primary": false + * } + * ] */ emails: { type?: string; @@ -110548,6 +120316,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-user"]; }; @@ -110557,49 +120328,43 @@ export interface operations { 404: components["responses"]["scim_not_found"]; }; }; - /** Delete a SCIM user from an organization */ "scim/delete-user-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["scim_forbidden"]; 404: components["responses"]["scim_not_found"]; }; }; - /** - * Update an attribute for a SCIM user - * @description Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). - * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated `:scim_user_id`. - * - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` - */ "scim/update-attribute-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -110608,34 +120373,31 @@ export interface operations { /** * @description Set of operations to be performed * @example [ - * { - * "op": "replace", - * "value": { - * "active": false - * } - * } - * ] + * { + * "op": "replace", + * "value": { + * "active": false + * } + * } + * ] */ Operations: { /** @enum {string} */ op: "add" | "remove" | "replace"; path?: string; - value?: OneOf< - [ - { + value?: + | { active?: boolean | null; userName?: string | null; externalId?: string | null; givenName?: string | null; familyName?: string | null; - }, - { + } + | { value?: string; primary?: boolean; - }[], - string, - ] - >; + }[] + | string; }[]; }; }; @@ -110643,6 +120405,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-user"]; }; @@ -110653,35 +120418,15 @@ export interface operations { 404: components["responses"]["scim_not_found"]; /** @description Response */ 429: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: - * - * `q=addClass+in:file+language:js+repo:jquery/jquery` - * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. - * - * Considerations for code search: - * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: - * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - * - * This endpoint requires you to authenticate and limits you to 10 requests per minute. - */ "search/code": { parameters: { query: { @@ -110697,13 +120442,22 @@ export interface operations { * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -110718,17 +120472,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - * - * 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/enterprise-cloud@latest//rest/search/search#text-match-metadata). - * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - * - * `q=repo:octocat/Spoon-Knife+css` - */ "search/commits": { parameters: { query: { @@ -110736,14 +120479,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -110755,21 +120508,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-cloud@latest//github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." - */ "search/issues-and-pull-requests": { parameters: { query: { @@ -110788,14 +120526,24 @@ export interface operations { | "interactions" | "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -110810,18 +120558,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - * - * `q=bug+defect+enhancement&repository_id=64778136` - * - * The labels that best match the query appear first in the search results. - */ "search/labels": { parameters: { query: { @@ -110831,14 +120567,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -110853,18 +120599,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: - * - * `q=tetris+language:assembly&sort=stars&order=desc` - * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - */ "search/repos": { parameters: { query: { @@ -110872,14 +120606,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -110893,30 +120637,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-cloud@latest//articles/searching-topics/)" for a detailed list of qualifiers. - * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: - * - * `q=ruby+is:featured` - * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - */ "search/topics": { parameters: { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Cloud. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Cloud. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-cloud@latest//rest/search/search#constructing-a-search-query). */ q: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -110928,20 +120669,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api). - * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/search/search#text-match-metadata). - * - * For example, if you're looking for a list of popular users, you might try this query: - * - * `q=tom+repos:%3E42+followers:%3E1000` - * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-cloud@latest//graphql/reference/queries#search)." - */ "search/users": { parameters: { query: { @@ -110949,14 +120676,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Cloud. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -110970,20 +120707,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name) endpoint. - */ "teams/get-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -110991,44 +120731,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - */ "teams/delete-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - */ "teams/update-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -111039,18 +120773,18 @@ export interface operations { description?: string; /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -111070,12 +120804,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -111085,31 +120825,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -111117,22 +120856,15 @@ export interface operations { }; }; }; - /** - * Create a discussion (Legacy) - * @deprecated - * @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/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -111152,75 +120884,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -111235,38 +120966,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -111274,23 +121008,17 @@ export interface operations { }; }; }; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @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/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest//github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest//rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -111303,78 +121031,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -111387,21 +121117,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { @@ -111415,20 +121139,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -111436,24 +121169,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -111477,21 +121205,15 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { @@ -111505,19 +121227,27 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -111525,23 +121255,17 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -111565,34 +121289,37 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List pending team invitations (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations) endpoint. - * - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub Enterprise Cloud member, the `login` field in the return hash will be `null`. - */ "teams/list-pending-invitations-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -111600,30 +121327,30 @@ export interface operations { }; }; }; - /** - * List team members (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members) endpoint. - * - * Team members will include the members of child teams. - */ "teams/list-members-legacy": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -111632,126 +121359,123 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get team member (Legacy) - * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/get-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if user is not a member */ 404: { - content: never; - }; - }; - }; - /** - * Add team member (Legacy) - * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ 422: { - content: never; - }; - }; - }; - /** - * Remove team member (Legacy) - * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/remove-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team synchronization is setup */ 404: { - content: never; - }; - }; - }; - /** - * Get team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/get-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; @@ -111759,27 +121483,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add or update team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - * - * **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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If 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. - */ "teams/add-or-update-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -111796,72 +121510,82 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//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 Enterprise Cloud team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Cloud](https://docs.github.com/enterprise-cloud@latest//articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ "teams/remove-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ "teams/list-projects-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -111870,46 +121594,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - */ "teams/check-permissions-for-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - */ "teams/add-or-update-project-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -111925,10 +121652,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -111940,49 +121673,53 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - */ "teams/remove-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List team repositories (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories) endpoint. - */ "teams/list-repos-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -111991,56 +121728,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a repository (Legacy) - * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types/) via the `Accept` header: - */ "teams/check-permissions-for-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with extra repository information */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions (Legacy) - * @deprecated - * @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/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. - * - * 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 method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - */ "teams/add-or-update-repo-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -112056,52 +121797,57 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - */ "teams/remove-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List IdP groups for a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List IdP groups for a team`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#list-idp-groups-for-a-team) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * List IdP groups connected to a team on GitHub Enterprise Cloud. - */ "teams/list-idp-groups-for-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["group-mapping"]; }; @@ -112110,20 +121856,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update IdP group connections (Legacy) - * @deprecated - * @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 or update IdP group connections`](https://docs.github.com/enterprise-cloud@latest//rest/teams/team-sync#create-or-update-idp-group-connections) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Creates, updates, or removes a connection between a team and an IdP group. When adding groups to a team, you must include all new and existing groups to avoid replacing existing groups with the new ones. Specifying an empty `groups` array will remove all connections for a team. - */ "teams/create-or-update-idp-group-connections-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -112151,6 +121892,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["group-mapping"]; }; @@ -112159,26 +121903,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List child teams (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams) endpoint. - */ "teams/list-child-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -112189,14 +121935,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. - */ "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -112208,11 +121960,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Update the authenticated user - * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. - */ "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -112256,6 +122010,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["private-user"]; }; @@ -112267,20 +122024,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List users blocked by the authenticated user - * @description List the users you've blocked on your personal account. - */ "users/list-blocked-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -112291,46 +122053,57 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is blocked by the authenticated user - * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. - */ "users/check-blocked": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the user is blocked */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description If the user is not blocked */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Block a user - * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. - */ "users/block": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -112339,20 +122112,24 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unblock a user - * @description Unblocks the given user and returns a 204. - */ "users/unblock": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -112360,23 +122137,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List codespaces for the authenticated user - * @description Lists the authenticated user's codespaces. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description ID of the Repository to filter on */ repository_id?: components["parameters"]["repository-id-in-query"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -112391,20 +122172,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a codespace for the authenticated user - * @description Creates a new codespace, owned by the authenticated user. - * - * This endpoint requires either a `repository_id` OR a `pull_request` but not both. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description Repository id for this codespace */ repository_id: number; /** @description Git ref (typically a branch name) for this codespace */ @@ -112432,8 +122210,8 @@ export interface operations { display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ retention_period_minutes?: number; - }, - { + } + | { /** @description Pull request number for this codespace */ pull_request: { /** @description Pull request number */ @@ -112456,20 +122234,24 @@ export interface operations { working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ idle_timeout_minutes?: number; - }, - ] - >; + }; }; }; responses: { /** @description Response when the codespace was successfully created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -112480,27 +122262,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List secrets for the authenticated user - * @description Lists all development environment secrets available for a user's codespaces without revealing their - * encrypted values. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/list-secrets-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -112511,61 +122291,58 @@ export interface operations { }; }; }; - /** - * Get public key for the authenticated user - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/get-public-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-user-public-key"]; }; }; }; }; - /** - * Get a secret for the authenticated user - * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/get-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-secret"]; }; }; }; }; - /** - * Create or update a secret for the authenticated user - * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-cloud@latest//rest/guides/encrypting-secrets-for-the-rest-api)." - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/create-or-update-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -112582,56 +122359,62 @@ export interface operations { responses: { /** @description Response after successfully creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response after successfully updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a secret for the authenticated user - * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/delete-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for a user secret - * @description List the repositories that have been granted the ability to use a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/list-repositories-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -112645,19 +122428,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Set selected repositories for a user secret - * @description Select the repositories that will use a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/set-repositories-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -112670,7 +122449,10 @@ export interface operations { responses: { /** @description No Content when repositories were added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -112678,25 +122460,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Add a selected repository to a user secret - * @description Adds a repository to the selected repositories for a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/add-repository-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -112704,25 +122486,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Remove a selected repository from a user secret - * @description Removes a repository from the selected repositories for a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/remove-repository-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -112730,21 +122512,23 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get a codespace for the authenticated user - * @description Gets information about a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/get-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -112756,18 +122540,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete a codespace for the authenticated user - * @description Deletes a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/delete-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 304: components["responses"]["not_modified"]; @@ -112777,19 +122560,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update a codespace for the authenticated user - * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. - * - * If you specify a new machine type it will be applied the next time your codespace is started. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/update-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -112806,6 +122585,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -112815,23 +122597,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/export-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace-export-details"]; }; @@ -112843,22 +122625,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get details about a codespace export - * @description Gets information about an export of a codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/get-export-details-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; + /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ export_id: components["parameters"]["export-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace-export-details"]; }; @@ -112866,21 +122651,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List machine types for a codespace - * @description List the machine types a codespace can transition to use. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/codespace-machines-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -112895,21 +122682,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a repository from an unpublished codespace - * @description 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. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/publish-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -112927,6 +122708,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace-with-full-repository"]; }; @@ -112937,21 +122721,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Start a codespace for the authenticated user - * @description Starts a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/start-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -112961,6 +122747,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Payment required */ 402: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -112971,21 +122760,23 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Stop a codespace for the authenticated user - * @description Stops a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/stop-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -112996,27 +122787,33 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get list of conflicting packages during Docker migration for authenticated-user - * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; }; }; }; - /** - * Set primary email visibility for the authenticated user - * @description Sets the visibility for your primary email addresses. - */ "users/set-primary-email-visibility-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -113031,6 +122828,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["email"][]; }; @@ -113042,25 +122842,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible - * to the public. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -113072,11 +122872,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -113091,6 +122893,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["email"][]; }; @@ -113102,11 +122907,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -113118,7 +122925,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -113127,22 +122937,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List followers of the authenticated user - * @description Lists the people following the authenticated user. - */ "users/list-followers-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -113153,22 +122966,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List the people the authenticated user follows - * @description Lists the people who the authenticated user follows. - */ "users/list-followed-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -113179,45 +122995,57 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Check if a person is followed by the authenticated user */ "users/check-person-is-followed-by-authenticated": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the person is followed by the authenticated user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/follow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -113225,20 +123053,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unfollow a user - * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/unfollow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -113246,24 +123078,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -113275,13 +123108,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -113295,6 +123128,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -113306,21 +123142,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/get-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -113331,22 +123169,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. - */ "users/delete-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -113355,26 +123195,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List app installations accessible to the user access token - * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You can find the permissions for the installation under the `permissions` key. - */ "apps/list-installations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -113388,29 +123227,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories accessible to the user access token - * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * The access the user has to each repository is included in the hash under the `permissions` key. - */ "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -113425,60 +123263,79 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add a repository to an app installation - * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get interaction restrictions for your public repositories - * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires. - */ "interactions/get-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Default response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["interaction-limit-response"] @@ -113487,15 +123344,20 @@ export interface operations { }; /** @description Response when there are no restrictions */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set interaction restrictions for your public repositories - * @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. - */ "interactions/set-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["interaction-limit"]; @@ -113504,6 +123366,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["interaction-limit-response"]; }; @@ -113511,34 +123376,24 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove interaction restrictions from your public repositories - * @description Removes any interaction restrictions from your public repositories. - */ "interactions/remove-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List user account issues assigned to the authenticated user - * @description 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 - * 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/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list-for-authenticated-user": { parameters: { query?: { @@ -113552,20 +123407,30 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -113575,24 +123440,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key"][]; @@ -113604,13 +123470,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -113627,6 +123493,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -113638,21 +123507,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/get-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -113663,22 +123534,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. - */ "users/delete-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -113686,22 +123559,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List subscriptions for the authenticated user - * @description Lists the active subscriptions for the authenticated user. - */ "apps/list-subscriptions-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["user-marketplace-purchase"][]; @@ -113712,22 +123588,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List subscriptions for the authenticated user (stubbed) - * @description Lists the active subscriptions for the authenticated user. - */ "apps/list-subscriptions-for-authenticated-user-stubbed": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["user-marketplace-purchase"][]; @@ -113737,24 +123616,27 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List organization memberships for the authenticated user - * @description Lists all of the authenticated user's organization memberships. - */ "orgs/list-memberships-for-authenticated-user": { parameters: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-membership"][]; @@ -113766,19 +123648,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization membership for the authenticated user - * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. - */ "orgs/get-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -113787,15 +123673,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization membership for the authenticated user - * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. - */ "orgs/update-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -113811,6 +123697,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -113820,22 +123709,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List user migrations - * @description Lists all migrations a user has started. - */ "migrations/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -113846,11 +123738,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Start a user migration - * @description Initiates the generation of a user migration archive. - */ "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -113893,8 +123787,8 @@ export interface operations { /** * @description Exclude attributes from the API response to improve performance * @example [ - * "repositories" - * ] + * "repositories" + * ] */ exclude?: "repositories"[]; repositories: string[]; @@ -113904,6 +123798,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -113914,29 +123811,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user migration status - * @description Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: - * - * * `pending` - the migration hasn't started yet. - * * `exporting` - the migration is in progress. - * * `exported` - the migration finished successfully. - * * `failed` - the migration failed. - * - * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive). - */ "migrations/get-status-for-authenticated-user": { parameters: { query?: { exclude?: string[]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -113947,60 +123840,48 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download a user migration archive - * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - */ "migrations/get-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a user migration archive - * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. - */ "migrations/delete-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -114008,21 +123889,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unlock a user repository - * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. - */ "migrations/unlock-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -114030,25 +123916,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories for a user migration - * @description Lists all the repositories for this user migration. - */ "migrations/list-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -114057,24 +123946,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organizations for the authenticated user - * @description List organizations for the authenticated user. - * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. - */ "orgs/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -114085,12 +123975,6 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List packages for the authenticated user's namespace - * @description Lists packages owned by the authenticated user within the user's namespace. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-authenticated-user": { parameters: { query: { @@ -114102,14 +123986,27 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -114117,104 +124014,112 @@ export interface operations { 400: components["responses"]["package_es_list_error"]; }; }; - /** - * Get a package for the authenticated user - * @description Gets a specific package for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for the authenticated user - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for the authenticated user - * @description Restores a package owned by the authenticated user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-authenticated-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by the authenticated user - * @description Lists package versions for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -114224,88 +124129,96 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for the authenticated user - * @description Gets a specific package version for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete a package version for the authenticated user - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package version for the authenticated user - * @description Restores a package version owned by the authenticated user. - * - * You can restore a deleted package version under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -114325,6 +124238,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -114335,26 +124251,25 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-public-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -114366,23 +124281,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories for the authenticated user - * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - */ "repos/list-for-authenticated-user": { parameters: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "public" | "private"; - /** - * @description Comma-separated list of values. Can include: - * * `owner`: Repositories that are owned by the authenticated user. - * * `collaborator`: Repositories that the user has been added to as a collaborator. - * * `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: + * * `owner`: Repositories that are owned by the authenticated user. + * * `collaborator`: Repositories that the user has been added to as a collaborator. + * * `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. */ affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ type?: "all" | "owner" | "public" | "private" | "member"; @@ -114390,15 +124297,26 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; + /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before-repo-date"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository"][]; }; @@ -114409,13 +124327,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a repository for the authenticated user - * @description Creates a new repository for the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -114507,34 +124425,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -114559,6 +124477,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -114572,22 +124491,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository invitations for the authenticated user - * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. - */ "repos/list-invitations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -114599,17 +124521,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Decline a repository invitation */ "repos/decline-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -114617,17 +124546,24 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** Accept a repository invitation */ "repos/accept-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -114635,22 +124571,25 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List social accounts for the authenticated user - * @description Lists all of your social accounts. - */ "users/list-social-accounts-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -114662,13 +124601,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -114683,6 +124622,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["social-account"][]; }; @@ -114694,13 +124636,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -114715,7 +124657,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -114724,24 +124669,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/list-ssh-signing-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -114753,13 +124699,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. - */ "users/create-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -114776,6 +124722,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -114787,21 +124736,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/get-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -114812,22 +124763,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. - */ "users/delete-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -114835,28 +124788,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories starred by the authenticated user - * @description Lists repositories the authenticated user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-authenticated-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository"][]; @@ -114868,48 +124822,61 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Check if a repository is starred by the authenticated user - * @description Whether the authenticated user has starred the repository. - */ "activity/check-repo-is-starred-by-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if this repository is starred by you */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description Not Found if this repository is not starred by you */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#http-method)." - */ "activity/star-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -114917,21 +124884,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unstar a repository for the authenticated user - * @description Unstar a repository that the authenticated user has previously starred. - */ "activity/unstar-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -114939,22 +124911,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories watched by the authenticated user - * @description Lists repositories the authenticated user is watching. - */ "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -114965,27 +124940,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. - * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. - * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. - */ "teams/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-full"][]; @@ -114996,25 +124969,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List users - * @description Lists all users, in the order that they signed up on GitHub Enterprise Cloud. This list includes personal user accounts and organization accounts. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. - */ "users/list": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -115023,23 +124997,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a user - * @description Provides publicly available information about someone with a GitHub account. - * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Cloud [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Cloud. For more information, see [Authentication](https://docs.github.com/enterprise-cloud@latest//rest/guides/getting-started-with-the-rest-api#authentication). - * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-cloud@latest//rest/users/emails)". - */ "users/get-by-username": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -115049,21 +125023,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get list of conflicting packages during Docker migration for user - * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -115072,92 +125048,114 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - */ "activity/list-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List organization events for the authenticated user - * @description This is the user's organization dashboard. You must be authenticated as the user to view this. - */ "activity/list-org-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events for a user */ "activity/list-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List followers of a user - * @description Lists the people following the specified user. - */ "users/list-followers-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -115165,25 +125163,28 @@ export interface operations { }; }; }; - /** - * List the people a user follows - * @description Lists the people who the specified user follows. - */ "users/list-following-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -115191,45 +125192,59 @@ export interface operations { }; }; }; - /** Check if a user follows another user */ "users/check-following-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; target_user: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the user follows the target user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if the user does not follow the target user */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List gists for a user - * @description Lists public gists for the specified user: - */ "gists/list-for-user": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -115238,25 +125253,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List GPG keys for a user - * @description Lists the GPG keys for a user. This information is accessible by anyone. - */ "users/list-gpg-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -115264,14 +125282,6 @@ export interface operations { }; }; }; - /** - * Get contextual information for a user - * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "users/get-context-for-user": { parameters: { query?: { @@ -115280,13 +125290,20 @@ export interface operations { /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ subject_id?: string; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hovercard"]; }; @@ -115295,46 +125312,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user installation for the authenticated app - * @description Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-user-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List public keys for a user - * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - */ "users/list-public-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key-simple"][]; @@ -115342,27 +125364,28 @@ export interface operations { }; }; }; - /** - * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-cloud@latest//articles/publicizing-or-concealing-organization-membership) for the specified user. - * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. - */ "orgs/list-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -115370,12 +125393,6 @@ export interface operations { }; }; }; - /** - * List packages for a user - * @description Lists all packages in a user's namespace for which the requesting user has access. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-user": { parameters: { query: { @@ -115387,17 +125404,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -115407,106 +125437,113 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for a user - * @description Gets a specific package metadata for a public package owned by a user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for a user - * @description Restores an entire package for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by a user - * @description Lists package versions for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -115516,109 +125553,119 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for a user - * @description Gets a specific package version for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for a user - * @description Restores a specific package version for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List user projects - * @description Lists projects for a user. - */ "projects/list-for-user": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -115627,53 +125674,62 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. - */ "activity/list-received-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events received by a user */ "activity/list-received-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List repositories for a user - * @description Lists public repositories for the specified user. - */ "repos/list-for-user": { parameters: { query?: { @@ -115683,18 +125739,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -115702,94 +125765,97 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. - * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "billing/get-github-actions-billing-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-billing-usage"]; }; }; }; }; - /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "billing/get-github-packages-billing-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["packages-billing-usage"]; }; }; }; }; - /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/enterprise-cloud@latest//github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "billing/get-shared-storage-billing-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-billing-usage"]; }; }; }; }; - /** - * List social accounts for a user - * @description Lists social media accounts for a user. This endpoint is accessible by anyone. - */ "users/list-social-accounts-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -115797,25 +125863,28 @@ export interface operations { }; }; }; - /** - * List SSH signing keys for a user - * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. - */ "users/list-ssh-signing-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -115823,31 +125892,32 @@ export interface operations { }; }; }; - /** - * List repositories starred by a user - * @description Lists repositories a user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -115857,25 +125927,28 @@ export interface operations { }; }; }; - /** - * List repositories watched by a user - * @description Lists repositories a user is watching. - */ "activity/list-repos-watched-by-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -115883,14 +125956,20 @@ export interface operations { }; }; }; - /** - * Get all API versions - * @description Get all supported GitHub Enterprise Cloud API versions. - */ "meta/get-all-versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -115898,79 +125977,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the Zen of GitHub - * @description Get a random sentence from the Zen of GitHub - */ "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string; }; }; }; }; - /** - * Compare two commits - * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. - * - * 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. - * - * 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, 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)." - * - * 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 following fields are included in the `verification` object: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; base: string; head: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; diff --git a/packages/openapi-types-ghes-3.10/types.d.ts b/packages/openapi-types-ghes-3.10/types.d.ts index 42aa73439..9554a1d66 100644 --- a/packages/openapi-types-ghes-3.10/types.d.ts +++ b/packages/openapi-types-ghes-3.10/types.d.ts @@ -3,350 +3,813 @@ * Do not make direct changes to the file. */ -/** OneOf type helpers */ -type Without = { [P in Exclude]?: never }; -type XOR = T | U extends object - ? (Without & U) | (Without & T) - : T | U; -type OneOf = T extends [infer Only] - ? Only - : T extends [infer A, infer B, ...infer Rest] - ? OneOf<[XOR, ...Rest]> - : never; - export interface paths { "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List global webhooks */ get: operations["enterprise-admin/list-global-webhooks"]; + put?: never; /** Create a global webhook */ post: operations["enterprise-admin/create-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a global webhook */ get: operations["enterprise-admin/get-global-webhook"]; + put?: never; + post?: never; /** Delete a global webhook */ delete: operations["enterprise-admin/delete-global-webhook"]; + options?: never; + head?: never; /** * Update a global webhook * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. */ patch: operations["enterprise-admin/update-global-webhook"]; + trace?: never; }; "/admin/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a global webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the webhook. */ post: operations["enterprise-admin/ping-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public keys */ get: operations["enterprise-admin/list-public-keys"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys/{key_ids}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a public key */ delete: operations["enterprise-admin/delete-public-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/ldap/teams/{team_id}/mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update LDAP mapping for a team * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ patch: operations["enterprise-admin/update-ldap-mapping-for-team"]; + trace?: never; }; "/admin/ldap/teams/{team_id}/sync": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync LDAP mapping for a team * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. */ post: operations["enterprise-admin/sync-ldap-mapping-for-team"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/ldap/users/{username}/mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** Update LDAP mapping for a user */ patch: operations["enterprise-admin/update-ldap-mapping-for-user"]; + trace?: never; }; "/admin/ldap/users/{username}/sync": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync LDAP mapping for a user * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. */ post: operations["enterprise-admin/sync-ldap-mapping-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an organization */ post: operations["enterprise-admin/create-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** Update an organization name */ patch: operations["enterprise-admin/update-org-name"]; + trace?: never; }; "/admin/pre-receive-environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List pre-receive environments */ get: operations["enterprise-admin/list-pre-receive-environments"]; + put?: never; /** Create a pre-receive environment */ post: operations["enterprise-admin/create-pre-receive-environment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive environment */ get: operations["enterprise-admin/get-pre-receive-environment"]; + put?: never; + post?: never; /** * Delete a pre-receive environment * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Cannot delete environment that has hooks_ + * * _Cannot delete environment when download is in progress_ */ delete: operations["enterprise-admin/delete-pre-receive-environment"]; + options?: never; + head?: never; /** * Update a pre-receive environment * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. */ patch: operations["enterprise-admin/update-pre-receive-environment"]; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a pre-receive environment download * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. + * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Can not start a new download when a download is in progress_ */ post: operations["enterprise-admin/start-pre-receive-environment-download"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the download status for a pre-receive environment * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. */ get: operations["enterprise-admin/get-download-status-for-pre-receive-environment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List pre-receive hooks */ get: operations["enterprise-admin/list-pre-receive-hooks"]; + put?: never; /** Create a pre-receive hook */ post: operations["enterprise-admin/create-pre-receive-hook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook */ get: operations["enterprise-admin/get-pre-receive-hook"]; + put?: never; + post?: never; /** Delete a pre-receive hook */ delete: operations["enterprise-admin/delete-pre-receive-hook"]; + options?: never; + head?: never; /** Update a pre-receive hook */ patch: operations["enterprise-admin/update-pre-receive-hook"]; + trace?: never; }; "/admin/tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List personal access tokens * @description Lists personal access tokens for all users, including admin users. */ get: operations["enterprise-admin/list-personal-access-tokens"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/tokens/{token_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a personal access token * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. */ delete: operations["enterprise-admin/delete-personal-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * - * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. + * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * - * If the login name or email address is already associated with an account, the server will return a `422` response. + * If the login name or email address is already associated with an account, the server will return a `422` response. */ post: operations["enterprise-admin/create-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a user * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#suspend-a-user) is often a better option. * - * You can delete any user account except your own. + * You can delete any user account except your own. */ delete: operations["enterprise-admin/delete-user"]; + options?: never; + head?: never; /** Update the username for a user */ patch: operations["enterprise-admin/update-username-for-user"]; + trace?: never; }; "/admin/users/{username}/authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an impersonation OAuth token */ post: operations["enterprise-admin/create-impersonation-o-auth-token"]; /** Delete an impersonation OAuth token */ delete: operations["enterprise-admin/delete-impersonation-o-auth-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated app * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installations for the authenticated app * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * - * The permissions the installation has are included under the `permissions` key. + * The permissions the installation has are included under the `permissions` key. */ get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. + * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/grants": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List your grants * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ get: operations["oauth-authorizations/list-grants"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/grants/{grant_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a single grant * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/get-grant"]; + put?: never; + post?: never; /** * Delete a grant * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["oauth-authorizations/delete-grant"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. @@ -357,760 +820,1532 @@ export interface paths { * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. */ delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; + trace?: never; }; "/applications/{client_id}/token/scoped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a scoped access token * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. + * which repositories the token can access and which permissions are granted to the + * token. * - * Invalid tokens will return `404 NOT FOUND`. + * Invalid tokens will return `404 NOT FOUND`. * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. + * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ post: operations["apps/scope-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List your authorizations * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/list-authorizations"]; + put?: never; /** * Create a new authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. * - * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use). + * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.10/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.10/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ post: operations["oauth-authorizations/create-authorization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/clients/{client_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Get-or-create an authorization for a specific app * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/clients/{client_id}/{fingerprint}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/{authorization_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a single authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/get-authorization"]; + put?: never; + post?: never; /** * Delete an authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ delete: operations["oauth-authorizations/delete-authorization"]; + options?: never; + head?: never; /** * Update an existing authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * You can only send one of these scope keys at a time. + * You can only send one of these scope keys at a time. */ patch: operations["oauth-authorizations/update-authorization"]; + trace?: never; }; "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get emojis * @description Lists all the emojis available to use on GitHub Enterprise Server. */ get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the global announcement banner * @description Gets the current message and expiration date of the global announcement banner in your enterprise. */ get: operations["enterprise-admin/get-announcement"]; + put?: never; + post?: never; /** * Remove the global announcement banner * @description Removes the global announcement banner in your enterprise. */ delete: operations["enterprise-admin/remove-announcement"]; + options?: never; + head?: never; /** * Set the global announcement banner * @description Sets the message and expiration time for the global announcement banner in your enterprise. */ patch: operations["enterprise-admin/set-announcement"]; + trace?: never; }; "/enterprise/settings/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get license information */ get: operations["enterprise-admin/get-license-information"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/all": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all statistics */ get: operations["enterprise-admin/get-all-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get comment statistics */ get: operations["enterprise-admin/get-comment-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get gist statistics */ get: operations["enterprise-admin/get-gist-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get hooks statistics */ get: operations["enterprise-admin/get-hooks-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get issue statistics */ get: operations["enterprise-admin/get-issue-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get milestone statistics */ get: operations["enterprise-admin/get-milestone-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get organization statistics */ get: operations["enterprise-admin/get-org-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pages statistics */ get: operations["enterprise-admin/get-pages-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pull request statistics */ get: operations["enterprise-admin/get-pull-request-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get repository statistics */ get: operations["enterprise-admin/get-repo-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/security-products": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get security products statistics * @description Gets the statistics about security products for a GitHub Enterprise Server instance. * - * To use this endpoint, you must be a site admin. + * To use this endpoint, you must be a site admin. */ get: operations["enterprise-admin/get-security-products"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get users statistics */ get: operations["enterprise-admin/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an enterprise * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/cache/usage-policy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage policy for an enterprise * @description Gets the GitHub Actions cache usage policy for an enterprise. * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-policy-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set GitHub Actions cache usage policy for an enterprise * @description Sets the GitHub Actions cache usage policy for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ patch: operations["actions/set-actions-cache-usage-policy-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an enterprise * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; /** * Set GitHub Actions permissions for an enterprise * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; /** * Set selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected organization for GitHub Actions in an enterprise * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + post?: never; /** * Disable a selected organization for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an enterprise * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-allowed-actions-enterprise"]; /** * Set allowed actions for an enterprise * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-allowed-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an enterprise * @description 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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-enterprise"]; /** * Set default workflow permissions for an enterprise * @description 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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * 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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an enterprise * @description Lists all self-hosted runner groups for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + put?: never; /** * Create a self-hosted runner group for an enterprise * @description Creates a new self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an enterprise * @description Gets a specific self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an enterprise * @description Deletes a self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an enterprise * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization access to a self-hosted runner group in an enterprise * @description Lists the organizations with access to a self-hosted runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Set organization access for a self-hosted runner group in an enterprise * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add organization access to a self-hosted runner group in an enterprise * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; /** * Remove organization access to a self-hosted runner group in an enterprise * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an enterprise * @description Lists the self-hosted runners that are in a specific enterprise group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Set self-hosted runners in a group for an enterprise * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an enterprise * @description Adds a self-hosted runner to a runner group configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + post?: never; /** * Remove a self-hosted runner from a group for an enterprise * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an enterprise * @description Lists all self-hosted runners configured for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an enterprise * @description Lists binaries for the runner application that you can download and run. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an Enterprise * @description Generates a configuration that can be passed to the runner application at startup. * - * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an enterprise * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * Example using registration token: + * Example using registration token: * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-registration-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an enterprise * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * Example using remove token: + * Example using remove token: * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-remove-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an enterprise * @description Gets a specific self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an enterprise * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an enterprise * @description Lists all labels for a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; /** * Set custom labels for a self-hosted runner for an enterprise * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. + * self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; /** * Add custom labels to a self-hosted runner for an enterprise * @description Add custom labels to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; /** * Remove all custom labels from a self-hosted runner for an enterprise * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. + * enterprise. Returns the remaining read-only labels from the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an enterprise * @description Remove a custom label from a self-hosted runner configured - * in an enterprise. Returns the remaining labels from the runner. + * 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an enterprise * @description Gets the audit log for an enterprise. * - * The authenticated user must be an enterprise admin to use this endpoint. + * The authenticated user must be an enterprise admin to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an enterprise * @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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. */ get: operations["code-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code_security_and_analysis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get code security and analysis features for an enterprise * @description Gets code security and analysis settings for the specified enterprise. * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["secret-scanning/get-security-analysis-settings-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update code security and analysis features for an enterprise * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ patch: operations["secret-scanning/patch-security-analysis-settings-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * 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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * 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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ get: operations["dependabot/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an enterprise * @description 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/enterprise-server@3.10/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. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ get: operations["secret-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an enterprise * @description 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-ghe"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature * @description Enables or disables the specified security feature for all repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ post: operations["secret-scanning/post-security-product-enablement-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public events * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ get: operations["activity/list-public-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get feeds * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * - * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. + * * **Timeline**: The GitHub Enterprise Server global public timeline + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List starred gists * @description List the authenticated user's starred gists: */ get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @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. */ patch: operations["gists/update"]; + trace?: never; }; "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update-comment"]; + trace?: never; }; "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist commits */ get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist forks */ get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a gist is starred */ get: operations["gists/check-is-starred"]; /** @@ -1118,144 +2353,362 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; + post?: never; /** Unstar a gist */ delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. */ get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issues assigned to the authenticated user * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/config/nodes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GHES node metadata for all nodes * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.10/admin/enterprise-management/configuring-clustering/about-clustering)." */ get: operations["enterprise-admin/get-config-nodes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/maintenance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the status of maintenance mode * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ get: operations["enterprise-admin/get-manage-maintenance"]; + put?: never; /** * Set the status of maintenance mode * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ post: operations["enterprise-admin/set-manage-maintenance"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/replication/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the status of services running on all replica nodes * @description Gets the status of all services running on each replica node. - * This endpoint may take several seconds to reply. + * This endpoint may take several seconds to reply. */ get: operations["enterprise-admin/get-replication-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/version": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all GHES release versions for all nodes * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.10/admin/all-releases)." */ get: operations["enterprise-admin/get-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Render a Markdown document */ post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get GitHub Enterprise Server meta information */ get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/networks/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a network of repositories */ get: operations["activity/list-public-events-for-repo-network"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. @@ -1266,192 +2719,327 @@ export interface paths { * @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 Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. */ patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread subscription for the authenticated user * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#get-a-repository-subscription). * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Octocat * @description Get the octocat as ASCII art */ get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations/{organization_id}/custom_roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Deprecated - List custom repository roles in an organization * @deprecated * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-roles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/). * - * To see the full details about an organization, the authenticated user must be an organization owner. + * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * - * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. + * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. */ get: operations["orgs/get"]; + put?: never; + post?: never; /** * Delete an organization * @description Deletes an organization and all its repositories. * - * The organization login will be unavailable for 90 days after deletion. + * The organization login will be unavailable for 90 days after deletion. * - * Please review the Terms of Service regarding account deletion before using this endpoint: + * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.10/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.10/site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; + options?: never; + head?: never; /** * Update an organization * @description **Parameter Deprecation Notice:** GitHub Enterprise Server 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). * - * Updates the organization's profile and member privileges. + * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ patch: operations["orgs/update"]; + trace?: never; }; "/orgs/{org}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an organization * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/cache/usage-by-repository": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["oidc/update-oidc-custom-sub-template-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories enabled for GitHub Actions in an organization * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** @@ -1459,1053 +3047,1717 @@ export interface paths { * @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)." * * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an organization * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions for an organization * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an organization * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; /** * Create a self-hosted runner group for an organization * @description Creates a new self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an organization * @description Gets a specific self-hosted runner group for an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an organization * @description Deletes a self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an organization * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository access to a self-hosted runner group in an organization * @description Lists the repositories with access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; /** * Set repository access for a self-hosted runner group in an organization * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add repository access to a self-hosted runner group in an organization * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; /** * Remove repository access to a self-hosted runner group in an organization * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an organization * @description Lists self-hosted runners that are in a specific organization group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-in-group-for-org"]; /** * Set self-hosted runners in a group for an organization * @description Replaces the list of self-hosted runners that are part of an organization runner group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an organization * @description Adds a self-hosted runner to a runner group configured in an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; /** * Remove a self-hosted runner from a group for an organization * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the organization. + * The authenticated user must have admin access to the organization. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** * Set custom labels for a self-hosted runner for an organization * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. + * self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization * @description Adds custom labels to a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** * Remove all custom labels from a self-hosted runner for an organization * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. + * organization. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an organization * @description Remove a custom label from a self-hosted runner configured - * in an organization. Returns the remaining labels from the runner. + * in an organization. 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * The authenticated user must have collaborator access to a repository to create, update, or read secrets * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to + * use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. For more information about setting the visibility, see [Create or + * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization variables * @description Lists all organization variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-variables"]; + put?: never; /** * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-org-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization variable * @description Gets a specific variable in an organization. * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-variable"]; + put?: never; + post?: never; /** * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-variable"]; + options?: never; + head?: never; /** * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ patch: operations["actions/update-org-variable"]; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization variable * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. + * that is available to selected repositories. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-variable"]; /** * Set selected repositories for an organization variable * @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`. + * to selected repositories. Organization variables that are available to selected + * repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-variable"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization variable * @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`. + * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-variable"]; + post?: never; /** * Remove selected repository from an organization variable * @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`. + * available to selected repositories. Organization variables that are available to + * selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-variable"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get announcement banner for organization * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. + * organization level. Organization members may also see an enterprise-level announcement banner. To get an + * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. */ get: operations["announcement-banners/get-announcement-banner-for-org"]; + put?: never; + post?: never; /** * Remove announcement banner from organization * @description Removes the announcement banner currently set for the organization. */ delete: operations["announcement-banners/remove-announcement-banner-for-org"]; + options?: never; + head?: never; /** * Set announcement banner for organization * @description Sets the announcement banner to display for the organization. */ patch: operations["announcement-banners/set-announcement-banner-for-org"]; + trace?: never; }; "/orgs/{org}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an organization * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. */ get: operations["orgs/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom repository roles in an organization * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-repo-roles"]; + put?: never; /** * Create a custom repository role * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-repo-role"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom repository role * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/get-custom-repo-role"]; + put?: never; + post?: never; /** * Delete a custom repository role * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-repo-role"]; + options?: never; + head?: never; /** * Update a custom repository role * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/update-custom-repo-role"]; + trace?: never; }; "/orgs/{org}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization + * permission to use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["dependabot/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public organization events */ get: operations["activity/list-public-org-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-group/{group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization webhooks * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description Create a hook that posts payloads in JSON format. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization webhook * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** * Delete an organization webhook * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping an organization webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) - * to be sent to the hook. + * to be sent to the hook. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations for an organization * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. + * all GitHub Apps installed on repositories in the organization. * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. @@ -2515,291 +4767,591 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * - * **Rate limits** + * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization migrations * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). * - * A list of `repositories` is only returned for export migrations. + * A list of `repositories` is only returned for export migrations. */ get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. * - * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.10/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.10/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization migration status * @description Fetches the status of a migration. * - * The `state` of a migration can be one of the following values: + * The `state` of a migration can be one of the following values: * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Convert an organization member to outside collaborator * @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/enterprise-server@3.10/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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; + put?: never; + post?: never; /** * Delete a package for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for an organization * @description Restores an entire package in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; + put?: never; + post?: never; /** * Delete package version for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for an organization * @description Restores a specific package version in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List requests to access organization resources with fine-grained personal access tokens * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-requests"]; + put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-requests-in-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review a request to access organization resources with a fine-grained personal access token * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories requested to be accessed by a fine-grained personal access token * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-request-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List fine-grained personal access tokens with access to organization resources * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grants"]; + put?: never; /** * Update the access to organization resources via fine-grained personal access tokens * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-accesses"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Update the access a fine-grained personal access token has to organization resources * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-access"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories a fine-grained personal access token has access to * @description Lists the repositories a fine-grained personal access token has access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pre-receive hooks for an organization * @description List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. */ get: operations["enterprise-admin/list-pre-receive-hooks-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook for an organization */ get: operations["enterprise-admin/get-pre-receive-hook-for-org"]; + put?: never; + post?: never; /** * Remove pre-receive hook enforcement for an organization * @description Removes any overrides for this hook at the org level for this org. */ delete: operations["enterprise-admin/remove-pre-receive-hook-enforcement-for-org"]; + options?: never; + head?: never; /** * Update pre-receive hook enforcement for an organization * @description For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration` */ patch: operations["enterprise-admin/update-pre-receive-hook-enforcement-for-org"]; + trace?: never; }; "/orgs/{org}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-org"]; + put?: never; /** * Create an organization project * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. */ get: operations["orgs/list-public-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check public organization membership for a user * @description Check if the provided user is a public member of the organization. @@ -2809,1406 +5361,2585 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; + post?: never; /** * Remove public organization membership for the authenticated user * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization repositories * @description 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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repository-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository fine-grained permissions for an organization * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-repo-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List security manager teams * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-security-manager-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a security manager team * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["orgs/add-security-manager-team"]; + post?: never; /** * Remove a security manager team * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-security-manager-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an organization * @description 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. + * 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ get: operations["teams/list"]; + put?: never; /** * Create a team * @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/enterprise-server@3.10/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/enterprise-server@3.10/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/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-in-org"]; + put?: never; /** * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-in-org"]; + put?: never; + post?: never; /** * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-in-org"]; + options?: never; + head?: never; /** * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-in-org"]; + put?: never; /** * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * **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`. + * **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`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-in-org"]; + put?: never; + post?: never; /** * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-in-org"]; + options?: never; + head?: never; /** * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; + put?: never; /** * Create reaction for a team discussion comment * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; + put?: never; /** * Create reaction for a team discussion * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; + put?: never; + post?: never; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + options?: never; + head?: never; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members * @description Team members will include the members of child teams. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user * @description Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/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. + * 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. * - * If 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. + * If 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. * - * **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}`. + * **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}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @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. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/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}`. + * **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}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; + post?: never; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **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}`. + * **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/enterprise-server@3.10/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/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature for an organization * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/cards/{card_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project card * @description Gets information about a project card. */ get: operations["projects/get-card"]; + put?: never; + post?: never; /** * Delete a project card * @description Deletes a project card */ delete: operations["projects/delete-card"]; + options?: never; + head?: never; /** Update an existing project card */ patch: operations["projects/update-card"]; + trace?: never; }; "/projects/columns/cards/{card_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project card */ post: operations["projects/move-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project column * @description Gets information about a project column. */ get: operations["projects/get-column"]; + put?: never; + post?: never; /** * Delete a project column * @description Deletes a project column. */ delete: operations["projects/delete-column"]; + options?: never; + head?: never; /** Update an existing project column */ patch: operations["projects/update-column"]; + trace?: never; }; "/projects/columns/{column_id}/cards": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project cards * @description Lists the project cards in a project. */ get: operations["projects/list-cards"]; + put?: never; /** Create a project card */ post: operations["projects/create-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project column */ post: operations["projects/move-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/get"]; + put?: never; + post?: never; /** * Delete a project * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ delete: operations["projects/delete"]; + options?: never; + head?: never; /** * Update a project * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ patch: operations["projects/update"]; + trace?: never; }; "/projects/{project_id}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project collaborators * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ get: operations["projects/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add project collaborator * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ put: operations["projects/add-collaborator"]; + post?: never; /** * Remove user as a collaborator * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ delete: operations["projects/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get project permission for a user * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ get: operations["projects/get-permission-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/columns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project columns * @description Lists the project columns in a project. */ get: operations["projects/list-columns"]; + put?: never; /** * Create a project column * @description Creates a new project column. */ post: operations["projects/create-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.10/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.10/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.10/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.10/rest/overview/api-versions)." + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.10/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.10/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.10/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.10/rest/overview/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository * @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. * - * **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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List artifacts for a repository * @description Lists all artifacts for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an artifact * @description Gets a specific artifact for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an artifact * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. - * 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. + * 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. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage-policy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage policy for a repository * @description Gets GitHub Actions cache usage policy for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-policy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set GitHub Actions cache usage policy for a repository * @description Sets GitHub Actions cache usage policy for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/set-actions-cache-usage-policy"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-list"]; + put?: never; + post?: never; /** * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a job for a workflow run * @description Gets a specific job in a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. + * for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization secrets * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization variables * @description Lists all organization variables shared with a repository. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-variables"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * - * You 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. + * You 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. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-workflow-access-to-repository"]; /** * Set the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-workflow-access-to-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for a repository * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You 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. + * You 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. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions for a repository * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/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)." + * as well as if GitHub Actions can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/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)." + * can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the repository. + * The authenticated user must have admin access to the repository. * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** * Set custom labels for a self-hosted runner for a repository * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. + * self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository * @description Adds custom labels to a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** * Remove all custom labels from a self-hosted runner for a repository * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. + * repository. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for a repository * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. + * in a repository. Returns the remaining labels from the runner. * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a repository * @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/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run * @description Gets a specific workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Deletes a specific workflow run. * - * Anyone with write access to the repository can use this endpoint. + * Anyone with write access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the review history for a workflow run * @description Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-reviews-for-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow run artifacts * @description Lists artifacts for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run attempt * @description Gets a specific workflow run attempt. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * **Note:** GitHub Apps can only review their own custom deployment protection rules. + * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ post: operations["actions/review-custom-gates-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. + * `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @description Deletes all logs for a workflow run. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-pending-deployments-for-run"]; + put?: never; /** * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/review-pending-deployments-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a workflow * @description Re-runs your workflow run using its `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run failed jobs from a workflow run * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow-failed-jobs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository variables * @description Lists all repository variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-variables"]; + put?: never; /** * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-repo-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository variable * @description Gets a specific variable in a repository. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-variable"]; + put?: never; + post?: never; /** * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-variable"]; + options?: never; + head?: never; /** * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-repo-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository workflows * @description Lists the workflows in a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow * @description Gets a specific workflow. You can replace `workflow_id` with the workflow - * file name. For example, you could use `main.yaml`. + * file name. For example, you could use `main.yaml`. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Disable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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`. * - * You 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)." + * You 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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a workflow * @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/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint + * Anyone with read access to the repository can use this endpoint * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.10/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned * @description Checks if a user has permission to be assigned to an issue in this repository. * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. * - * Otherwise a `404` status code is returned. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an autolink reference of a repository * @description This returns a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if automated security fixes are enabled for a repository * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.10/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List branches */ get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a branch */ get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get branch protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -4218,106 +7949,161 @@ export interface paths { * Update branch protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Protecting a branch requires admin or owner permissions to the repository. + * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get admin branch protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pull request review protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit signature protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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/enterprise-server@3.10/articles/signing-commits-with-gpg) in GitHub Help. + * When 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/enterprise-server@3.10/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * **Note**: You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get status checks protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ patch: operations["repos/update-status-check-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all status check contexts * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -4338,1841 +8124,3102 @@ export interface paths { * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists who has access to this protected branch. + * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Disables the ability to restrict who can push to this branch. + * Disables the ability to restrict who can push to this branch. */ delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get apps with access to the protected branch * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * 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/enterprise-server@3.10/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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * 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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get teams with access to the protected branch * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. The list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified teams push access for this branch. You can also give push access to child teams. + * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get users with access to the protected branch * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the people who have push access to this branch. + * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ put: operations["repos/set-user-access-restrictions"]; /** * Add user 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified people push access for this branch. + * Grants the specified people push access for this branch. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ post: operations["repos/add-user-access-restrictions"]; /** * Remove user 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a user to push to this branch. + * Removes the ability of a user to push to this branch. * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/rename": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rename a branch * @description Renames a branch in a repository. * - * **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/enterprise-server@3.10/github/administering-a-repository/renaming-a-branch)". + * **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/enterprise-server@3.10/github/administering-a-repository/renaming-a-branch)". * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ post: operations["repos/rename-branch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check run * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ patch: operations["checks/update"]; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check run annotations * @description Lists annotations for a check run using the annotation `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch (or for the specified Git reference if you used `ref` in the request). * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning alert * @description Gets a single code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning analyses for a repository * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `category` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set: + * `next_analysis_url` and `confirm_delete_url`. + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in a set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find an analysis that's identified as deletable. + * Each set of analyses always has one that's identified as deletable. + * Having found the deletable analysis for one of the two sets, + * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + * Then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-default-setup"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-default-setup"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif)." * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - 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)." * - * You 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: + * You 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: * - * ``` - * gzip -c analysis-data.sarif | base64 -w0 - * ``` + * ``` + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. | + * | **SARIF data** | **Maximum values** | **Additional limits** | + * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| + * | Runs per file | 20 | | + * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * The `202 Accepted` response includes an `id` value. + * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS - * file. + * file. * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * For more information about the correct CODEOWNERS syntax, + * see "[About code owners](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is a repository collaborator * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/check-collaborator"]; /** * Add a repository collaborator * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * 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-server@3.10/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-server@3.10/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/enterprise-server@3.10/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: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/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: * - * ``` - * Cannot assign {member} permission of {role name} - * ``` + * ``` + * Cannot assign {member} permission of {role name} + * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Updating an existing collaborator's permission level** + * **Updating an existing collaborator's permission level** * - * The 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. + * The 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. */ put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. + * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages + * This endpoint also: + * - Cancels any outstanding invitations + * - Unasigns the user from any issues + * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. + * - Unstars the repository + * - Updates access permissions to packages * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + * Removing a user as a collaborator has the following effects on forks: + * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + * - If the user had their own fork of the repository, the fork will be deleted. + * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. + * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository permissions for a user * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * permissions are `admin`, `write`, `read`, and `none`. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the + * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. */ get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["repos/update-commit-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List branches for HEAD commit * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests associated with a commit * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * - * **Signature verification object** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the combined status for a specific reference * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * * - * Additionally, a combined `state` is returned. The `state` is one of: + * Additionally, a combined `state` is returned. The `state` is one of: * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` */ get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit statuses for a reference * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-server@3.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * - * 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 API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. + * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. * - * **Working with large comparisons** + * **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: + * 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. + * - 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. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." * - * **Signature verification object** + * **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 `verification` object includes the following fields: * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits-with-basehead"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * - * **Notes**: + * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository contributors * @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. * - * 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. + * 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. */ get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for a repository * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a Dependabot alert * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a Dependabot alert * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["dependabot/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @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. + * encrypt a secret before you can create or update secrets. Anyone with read access + * to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ get: operations["dependabot/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["dependabot/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["dependabot/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a diff of the dependencies between commits * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */ get: operations["dependency-graph/diff-range"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/sbom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Export a software bill of materials (SBOM) for a repository. * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. */ get: operations["dependency-graph/export-sbom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a snapshot of dependencies for a repository * @description Create a new snapshot of a repository's dependencies. * - * The authenticated user must have access to the repository. + * The authenticated user must have access to the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["dependency-graph/create-repository-snapshot"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them - * before we merge a pull request. + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them + * before we merge a pull request. * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. * - * Merged branch response: + * Merged branch response: * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. * - * Merge conflict response: + * Merge conflict response: * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. * - * Failed commit status checks: + * Failed commit status checks: * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deployment */ get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * 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. * - * To set a deployment as inactive, you must: + * To set a deployment as inactive, you must: * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. + * * 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/enterprise-server@3.10/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#create-a-deployment-status)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#repository_dispatch)." * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * This input example shows how you can use the `client_payload` as a test to debug your workflow. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment * @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)." * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-environment"]; /** * Create or update an environment * @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)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all deployment protection rules for an environment * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-deployment-protection-rules"]; + put?: never; /** * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-protection-rule"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom deployment rule integrations available for an environment * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app)". * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-custom-deployment-rule-integrations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom deployment protection rule * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-custom-deployment-protection-rule"]; + put?: never; + post?: never; /** * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/disable-deployment-protection-rule"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment secrets * @description Lists all secrets available in an environment without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment public key * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. + * 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. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment secret * @description Gets a single environment secret without revealing its encrypted value. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-secret"]; /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-environment-secret"]; + post?: never; /** * Delete an environment secret * @description Deletes a secret in an environment using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment variables * @description Lists all environment variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-variables"]; + put?: never; /** * Create an environment variable * @description Create an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment variable * @description Gets a specific variable in an environment. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; /** * Delete an environment variable * @description Deletes an environment variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; /** * Update an environment variable * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-environment-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * */ get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List forks */ get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * - **`application/vnd.github.raw+json`**: Returns the raw blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. * - * **Note** This endpoint supports blobs up to 100 megabytes in size. + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit object * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." + * + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List matching references * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a reference * @description Deletes the provided reference. */ delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** * Update a reference * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ patch: operations["git/update-ref"]; + trace?: never; }; "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tag * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.10/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.10/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.10/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.10/rest/git/refs#update-a-reference)." * - * Returns an error if you try to delete a file that does not exist. + * Returns an error if you try to delete a file that does not exist. */ post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tree * @description Returns a single tree using the SHA1 value or ref name for that tree. * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. + * share the same `config` as long as those webhooks do not have any `events` that overlap. */ post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ patch: operations["repos/update-invitation"]; + trace?: never; }; "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.10/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments for a repository * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * - * By default, issue comments are ordered by ascending ID. + * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events for a repository * @description Lists events for a repository. */ get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue event * @description Gets a single event by the event id. */ get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.10/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-server@3.10/webhooks/event-payloads/#issues) webhook. + * [transferred](https://docs.github.com/enterprise-server@3.10/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * 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/enterprise-server@3.10/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 - * 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/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. @@ -6183,59 +11230,107 @@ export interface paths { * @description Removes one or more assignees from an issue. */ delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned to a issue * @description 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. + * 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. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * Issue comments are ordered by ascending ID. + * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events * @description Lists all events for an issue. */ get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for an issue * @description Lists all labels for an issue. @@ -6256,183 +11351,403 @@ export interface paths { * @description Removes all labels from an issue. */ delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List deploy keys */ get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deploy key */ get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a repository * @description Lists all labels for a repository. */ get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a label * @description Gets a label using the given name. */ get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ patch: operations["issues/update-label"]; + trace?: never; }; "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable Git LFS for a repository * @description Enables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["repos/enable-lfs-for-repo"]; + post?: never; /** * Disable Git LFS for a repository * @description Disables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["repos/disable-lfs-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List milestones * @description Lists milestones for a repository. */ get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ patch: operations["issues/update-milestone"]; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. @@ -6443,352 +11758,585 @@ export interface paths { * @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 Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GitHub Enterprise Server Pages site * @description Gets information about a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub Enterprise Server Pages site * @description Updates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Enterprise Server Pages site * @description Configures a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub Enterprise Server Pages site * @description Deletes a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Enterprise Server Pages builds * @description Lists builts of a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub Enterprise Server Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Enterprise Server Pages build * @description Gets information about a GitHub Enterprise Server Pages build. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * The authenticated user must have write permission to the repository. + * The authenticated user must have write permission to the repository. */ post: operations["repos/create-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pre-receive hooks for a repository * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. */ get: operations["enterprise-admin/list-pre-receive-hooks-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook for a repository */ get: operations["enterprise-admin/get-pre-receive-hook-for-repo"]; + put?: never; + post?: never; /** * Remove pre-receive hook enforcement for a repository * @description Deletes any overridden enforcement on this repository for the specified hook. * - * Responds with effective values inherited from owner and/or global level. + * Responds with effective values inherited from owner and/or global level. */ delete: operations["enterprise-admin/remove-pre-receive-hook-enforcement-for-repo"]; + options?: never; + head?: never; /** * Update pre-receive hook enforcement for a repository * @description For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` */ patch: operations["enterprise-admin/update-pre-receive-hook-enforcement-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-repo"]; + put?: never; /** * Create a repository project * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests * @description Lists pull requests in a specified repository. * - * 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. + * 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments in a repository * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. + * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists details of a pull request by providing its number. + * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments on a pull request * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. + * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#create-an-issue-comment)." * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reply for a review comment * @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. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits) - * endpoint. + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits) + * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. @@ -6797,16 +12345,29 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. @@ -6817,406 +12378,782 @@ export interface paths { * @description Removes review requests from a pull request for a given set of users and/or teams. */ delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * 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/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/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. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) endpoint. * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List releases * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-tags). * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release asset * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ patch: operations["repos/update-release-asset"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/generate-notes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Generate release notes content for a release * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the latest release * @description View the latest published full release for the repository. * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ patch: operations["repos/update-release"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List release assets */ get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release) to upload a release asset. + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release) to upload a release asset. * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: * - * `application/zip` + * `application/zip` * - * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. + * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * - * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + * **Notes:** + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/replicas/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository cache replication status * @description Lists the status of each repository cache replica. */ get: operations["repos/list-cache-info"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["secret-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit activity * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all contributor commit activity * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits */ get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit count * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * - * The array order is oldest week (index 0) to most recent week. + * The array order is oldest week (index 0) to most recent week. * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. + * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the hourly commit count for each day * @description Each array contains the day number, hour number, and number of commits: * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List watchers * @description Lists the people watching the specified repository. */ get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. @@ -7227,74 +13164,174 @@ export interface paths { * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List repository tags */ get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List tag protection states for a repository * @description This returns the tag protection states of a repository. * - * This information is only available to repository administrators. + * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; + put?: never; /** * Create a tag protection state for a repository * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a tag protection state for a repository * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (tar) * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * `main`) 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. */ get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository teams * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. * - * For a public repository, a team is listed only if that team added the public repository explicitly. + * For a public repository, a team is listed only if that team added the public repository explicitly. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all repository topics */ get: operations["repos/get-all-topics"]; /** Replace all repository topics */ put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.10/articles/about-repository-transfers/). */ post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if vulnerability alerts are enabled for a repository * @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/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". @@ -7305,350 +13342,586 @@ export interface paths { * @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/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". */ put: operations["repos/enable-vulnerability-alerts"]; + post?: never; /** * Disable vulnerability alerts * @description Disables dependency alerts 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/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". + * The authenticated user must have admin access to the repository. For more information, + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". */ delete: operations["repos/disable-vulnerability-alerts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (zip) * @description 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 - * the `Location` header to make a second `GET` request. + * `main`) 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. + * **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. */ get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public repositories * @description Lists all public repositories in the order that they were created. * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Lists provisioned SCIM groups in an enterprise. + * Lists provisioned SCIM groups in an enterprise. * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. + * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. */ get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + put?: never; /** * Provision a SCIM enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Creates a SCIM group for an enterprise. + * Creates a SCIM group for an enterprise. * - * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. + * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ post: operations["enterprise-admin/provision-enterprise-group"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Gets information about a SCIM group. + * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Replaces an existing provisioned group’s information. + * Replaces an existing provisioned group’s information. * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + post?: never; /** * Delete a SCIM group from an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Update a provisioned group’s individual attributes. + * Update a provisioned group’s individual attributes. * - * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. + * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. * - * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. + * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Lists provisioned SCIM enterprise members. + * Lists provisioned SCIM enterprise members. * - * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. + * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. */ get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + put?: never; /** * Provision a SCIM enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Creates an external identity for a new SCIM enterprise user. + * Creates an external identity for a new SCIM enterprise user. * - * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. + * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. * - * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. + * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ post: operations["enterprise-admin/provision-enterprise-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Gets information about a SCIM user. + * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Replaces an existing provisioned user's information. + * Replaces an existing provisioned user's information. * - * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. + * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + post?: never; /** * Delete a SCIM user from an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. + * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Update a provisioned user's individual attributes. + * Update a provisioned user's individual attributes. * - * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false + * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] * } - * }] - * } - * ``` + * ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; + trace?: never; }; "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * - * `q=addClass+in:file+language:js+repo:jquery/jquery` + * `q=addClass+in:file+language:js+repo:jquery/jquery` * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. * - * Considerations for code search: + * Considerations for code search: * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search commits * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). * - * 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/enterprise-server@3.10/rest/search/search#text-match-metadata). + * 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/enterprise-server@3.10/rest/search/search#text-match-metadata). * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * - * `q=repo:octocat/Spoon-Knife+css` + * `q=repo:octocat/Spoon-Knife+css` */ get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search issues and pull requests * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * - * `q=bug+defect+enhancement&repository_id=64778136` + * `q=bug+defect+enhancement&repository_id=64778136` * - * The labels that best match the query appear first in the search results. + * The labels that best match the query appear first in the search results. */ get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * - * `q=tetris+language:assembly&sort=stars&order=desc` + * `q=tetris+language:assembly&sort=stars&order=desc` * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.10/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * - * `q=ruby+is:featured` + * `q=ruby+is:featured` * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). * - * For example, if you're looking for a list of popular users, you might try this query: + * For example, if you're looking for a list of popular users, you might try this query: * - * `q=tom+repos:%3E42+followers:%3E1000` + * `q=tom+repos:%3E42+followers:%3E1000` * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search)." */ get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/configcheck": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the configuration status * @description This endpoint allows you to check the status of the most recent configuration process: * - * Note that you may need to wait several seconds after you start a process before you can check its status. + * Note that you may need to wait several seconds after you start a process before you can check its status. * - * The different statuses are: + * The different statuses are: * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | + * | Status | Description | + * | ------------- | --------------------------------- | + * | `PENDING` | The job has not started yet | + * | `CONFIGURING` | The job is running | + * | `DONE` | The job has finished correctly | + * | `FAILED` | The job has finished unexpectedly | */ get: operations["enterprise-admin/get-configuration-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/configure": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a configuration process * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: */ post: operations["enterprise-admin/start-configuration-process"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/maintenance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the maintenance status * @description Check your installation's maintenance status: */ get: operations["enterprise-admin/get-maintenance-status"]; + put?: never; /** * Enable or disable maintenance mode * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get settings * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * **Note:** You cannot retrieve the management console password with the Enterprise administration API. */ get: operations["enterprise-admin/get-settings"]; /** * Set settings * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings). * - * **Notes:** + * **Notes:** * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." */ put: operations["enterprise-admin/set-settings"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/settings/authorized-keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all authorized SSH keys */ get: operations["enterprise-admin/get-all-authorized-ssh-keys"]; + put?: never; /** * Add an authorized SSH key * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). @@ -7659,239 +13932,369 @@ export interface paths { * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ delete: operations["enterprise-admin/remove-authorized-ssh-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/start": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub license * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: + * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. + * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. + * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/create-enterprise-server-license"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/upgrade-license"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#delete-a-team) endpoint. * - * To delete a team, the authenticated user must be an organization owner or team maintainer. + * To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#update-a-team) endpoint. * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. + * List all discussions on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-legacy"]; + put?: never; /** * Create a discussion (Legacy) * @deprecated * @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/enterprise-server@3.10/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. + * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. + * Get a specific discussion on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-legacy"]; + put?: never; + post?: never; /** * Delete a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. + * Delete a discussion from a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-legacy"]; + options?: never; + head?: never; /** * Update a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. + * List all comments on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-legacy"]; + put?: never; /** * Create a discussion comment (Legacy) * @deprecated * @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/enterprise-server@3.10/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. + * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. + * Get a specific comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-legacy"]; + put?: never; + post?: never; /** * Delete a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. + * Deletes a comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-legacy"]; + options?: never; + head?: never; /** * Update a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. + * Edits the body text of a discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; + put?: never; /** * Create reaction for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-legacy"]; + put?: never; /** * Create reaction for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.10/rest/teams/members#list-team-members) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. */ get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team member (Legacy) * @deprecated * @description The "Get team member" endpoint (described below) is deprecated. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/get-member-legacy"]; /** @@ -7899,46 +14302,57 @@ export interface paths { * @deprecated * @description The "Add team member" endpoint (described below) is deprecated. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated * @description The "Remove team member" endpoint (described below) is deprecated. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** @@ -7946,47 +14360,71 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * - * If 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. + * If 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. */ put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/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. + * 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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-projects) endpoint. * - * Lists the organization projects for a team. + * Lists the organization projects for a team. */ get: operations["teams/list-projects-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ get: operations["teams/check-permissions-for-project-legacy"]; /** @@ -7994,35 +14432,59 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ put: operations["teams/add-or-update-project-permissions-legacy"]; + post?: never; /** * Remove a project from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-project-from-a-team) endpoint. * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ delete: operations["teams/remove-project-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository (Legacy) * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** @@ -8030,58 +14492,108 @@ export interface paths { * @deprecated * @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/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * - * 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. + * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ patch: operations["users/update-authenticated"]; + trace?: never; }; "/user/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List email addresses for the authenticated user * @description Lists all of your email addresses, and specifies which one is visible - * to the public. + * to the public. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-emails-for-authenticated-user"]; + put?: never; /** * Add an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. @@ -8092,418 +14604,827 @@ export interface paths { * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-email-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a person is followed by the authenticated user */ get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for the authenticated user * @description Lists the current user's GPG keys. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GPG key for the authenticated user * @description View extended details for a single GPG key. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You can find the permissions for the installation under the `permissions` key. + * You can find the permissions for the installation under the `permissions` key. */ get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the user access token * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * The access the user has to each repository is included in the hash under the `permissions` key. + * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user account issues assigned to the authenticated user * @description 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 - * 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/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public SSH keys for the authenticated user * @description Lists the public SSH keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a public SSH key for the authenticated user * @description View extended details for a single public SSH key. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user migrations * @description Lists all migrations a user has started. */ get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a user migration archive * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package for the authenticated user * @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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for the authenticated user * @description Restores a package owned by the authenticated user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package version for the authenticated user * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. + * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package version for the authenticated user * @description Restores a package version owned by the authenticated user. * - * You can restore a deleted package version under the following conditions: - * - 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. + * You can restore a deleted package version under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user project * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/public_emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-public-emails-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for the authenticated user * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; "/user/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for the authenticated user * @description Lists all of your social accounts. */ get: operations["users/list-social-accounts-for-authenticated-user"]; + put?: never; /** * Add social accounts for the authenticated user * @description Add one or more social accounts to the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user * @description Deletes one or more social accounts from the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-social-account-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for the authenticated user * @description Lists the SSH signing keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; + put?: never; /** * Create a SSH signing key for the authenticated user * @description Creates an SSH signing key for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ post: operations["users/create-ssh-signing-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys/{ssh_signing_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an SSH signing key for the authenticated user * @description Gets extended details for an SSH signing key. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/get-ssh-signing-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete an SSH signing key for the authenticated user * @description Deletes an SSH signing key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. @@ -8514,372 +15435,826 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams for the authenticated user * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. + * user belongs. * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.10/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.10/rest/users/emails)". */ get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. */ get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a user */ get: operations["activity/list-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of a user * @description Lists the people following the specified user. */ get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a user follows another user */ get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for a user * @description Lists public gists for the specified user: */ get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for a user * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.10/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; + put?: never; + post?: never; /** * Delete a package for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for a user * @description Restores an entire package for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; + put?: never; + post?: never; /** * Delete package version for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for a user * @description Restores a specific package version for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user projects * @description Lists projects for a user. */ get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events received by the authenticated user * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ get: operations["activity/list-received-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events received by a user */ get: operations["activity/list-received-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/site_admin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Promote a user to be a site administrator * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/promote-user-to-be-site-administrator"]; + post?: never; /** * Demote a site administrator * @description You can demote any user account except your own. */ delete: operations["enterprise-admin/demote-site-administrator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for a user * @description Lists social media accounts for a user. This endpoint is accessible by anyone. */ get: operations["users/list-social-accounts-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for a user * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. */ get: operations["users/list-ssh-signing-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * - * You can suspend any user account except your own. + * You can suspend any user account except your own. * - * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/suspend-user"]; + post?: never; /** * Unsuspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ delete: operations["enterprise-admin/unsuspend-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{base}...{head}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. * - * 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. + * 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. * - * 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. + * 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** + * **Working with large comparisons** * - * 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)." + * 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)." * - * 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. + * 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** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } - export type webhooks = Record; - export interface components { schemas: { root: { @@ -9303,11 +16678,11 @@ export interface components { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ "app-permissions": { /** @@ -9617,12 +16992,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** * Format: uri @@ -9711,9 +17084,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -9726,9 +17099,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -10087,12 +17460,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -10326,7 +17697,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -10359,7 +17730,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -10371,7 +17742,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -10392,69 +17763,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -10463,14 +17834,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -10494,12 +17865,10 @@ export interface components { single_file?: string; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; }; /** @@ -10530,11 +17899,9 @@ export interface components { * @example 2011-09-06T20:39:23Z */ updated_at: string; - /** - * @example [ - * "public_repo" - * ] - */ + /** @example [ + * "public_repo" + * ] */ scopes: string[]; user?: components["schemas"]["nullable-simple-user"]; }; @@ -10552,53 +17919,52 @@ export interface components { * @example https://api.github.com/codes_of_conduct/contributor_covenant */ url: string; - /** - * @example # Contributor Covenant Code of Conduct + /** @example # Contributor Covenant Code of Conduct * - * ## Our Pledge + * ## Our Pledge * - * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. * - * ## Our Standards + * ## Our Standards * - * Examples of behavior that contributes to creating a positive environment include: + * Examples of behavior that contributes to creating a positive environment include: * - * * Using welcoming and inclusive language - * * Being respectful of differing viewpoints and experiences - * * Gracefully accepting constructive criticism - * * Focusing on what is best for the community - * * Showing empathy towards other community members + * * Using welcoming and inclusive language + * * Being respectful of differing viewpoints and experiences + * * Gracefully accepting constructive criticism + * * Focusing on what is best for the community + * * Showing empathy towards other community members * - * Examples of unacceptable behavior by participants include: + * Examples of unacceptable behavior by participants include: * - * * The use of sexualized language or imagery and unwelcome sexual attention or advances - * * Trolling, insulting/derogatory comments, and personal or political attacks - * * Public or private harassment - * * Publishing others' private information, such as a physical or electronic address, without explicit permission - * * Other conduct which could reasonably be considered inappropriate in a professional setting + * * The use of sexualized language or imagery and unwelcome sexual attention or advances + * * Trolling, insulting/derogatory comments, and personal or political attacks + * * Public or private harassment + * * Publishing others' private information, such as a physical or electronic address, without explicit permission + * * Other conduct which could reasonably be considered inappropriate in a professional setting * - * ## Our Responsibilities + * ## Our Responsibilities * - * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - * to any instances of unacceptable behavior. + * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + * to any instances of unacceptable behavior. * - * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. * - * ## Scope + * ## Scope * - * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. * - * ## Enforcement + * ## Enforcement * - * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. * - * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. * - * ## Attribution + * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - */ + * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + * */ body?: string; /** Format: uri */ html_url: string | null; @@ -10798,12 +18164,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -10884,12 +18250,10 @@ export interface components { * @example 2016-07-11T22:14:10Z */ expires_at: string; - /** - * @example { - * "issues": "read", - * "deployments": "write" - * } - */ + /** @example { + * "issues": "read", + * "deployments": "write" + * } */ permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; @@ -10977,32 +18341,32 @@ export interface components { | "dismissed" | "fixed"; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string} @@ -11012,12 +18376,12 @@ export interface components { * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -11056,10 +18420,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ "code-scanning-analysis-analysis-key": string; @@ -11097,10 +18459,8 @@ export interface components { }; location?: components["schemas"]["code-scanning-alert-location"]; html_url?: string; - /** - * @description Classifications that have been applied to the file that triggered the alert. - * For example identifying it as documentation, or a generated file. - */ + /** @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. */ classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; /** @@ -11366,25 +18726,25 @@ export interface components { "enterprise-security-analysis-settings": { /** * @description Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to - * this enterprise. + * this enterprise. * @example false */ advanced_security_enabled_for_new_repositories: boolean; /** * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ dependabot_alerts_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ secret_scanning_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this enterprise. + * transferred to this enterprise. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories: boolean; @@ -11395,15 +18755,15 @@ export interface components { secret_scanning_push_protection_custom_link?: string | null; }; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -11418,7 +18778,7 @@ export interface components { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -11428,7 +18788,7 @@ export interface components { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -11442,14 +18802,14 @@ export interface components { readonly vector_string: string | null; }; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -11459,7 +18819,7 @@ export interface components { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -11486,7 +18846,7 @@ export interface components { * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -11494,10 +18854,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -11535,7 +18895,7 @@ export interface components { * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "nullable-alert-updated-at": string | null; + "nullable-alert-updated-at": string | null; /** * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} @@ -11572,10 +18932,8 @@ export interface components { resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -11741,9 +19099,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -11756,9 +19114,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -11857,14 +19215,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -11874,9 +19231,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -12013,11 +19369,9 @@ export interface components { current_user_actor_url?: string; /** @example https://github.com/octocat-org */ current_user_organization_url?: string; - /** - * @example [ - * "https://github.com/organizations/github/octocat.private.atom?token=abc123" - * ] - */ + /** @example [ + * "https://github.com/organizations/github/octocat.private.atom?token=abc123" + * ] */ current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ security_advisories_url?: string; @@ -12064,13 +19418,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12211,13 +19567,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12243,15 +19601,17 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; + [key: string]: + | ({ + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + } | null) + | undefined; }; public?: boolean; created_at?: string; @@ -12326,25 +19686,24 @@ export interface components { "gitignore-template": { /** @example C */ name: string; - /** - * @example # Object files - * *.o + /** @example # Object files + * *.o * - * # Libraries - * *.lib - * *.a + * # Libraries + * *.lib + * *.a * - * # Shared objects (inc. Windows DLLs) - * *.dll - * *.so - * *.so.* - * *.dylib + * # Shared objects (inc. Windows DLLs) + * *.dll + * *.so + * *.so.* + * *.dylib * - * # Executables - * *.exe - * *.out - * *.app - */ + * # Executables + * *.exe + * *.out + * *.app + * */ source: string; }; /** @@ -12395,53 +19754,46 @@ export interface components { description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ implementation: string; - /** - * @example [ - * "commercial-use", - * "modifications", - * "distribution", - * "sublicense", - * "private-use" - * ] - */ + /** @example [ + * "commercial-use", + * "modifications", + * "distribution", + * "sublicense", + * "private-use" + * ] */ permissions: string[]; - /** - * @example [ - * "include-copyright" - * ] - */ + /** @example [ + * "include-copyright" + * ] */ conditions: string[]; - /** - * @example [ - * "no-liability" - * ] - */ + /** @example [ + * "no-liability" + * ] */ limitations: string[]; - /** - * @example + /** @example * - * The MIT License (MIT) + * The MIT License (MIT) * - * Copyright (c) [year] [fullname] + * Copyright (c) [year] [fullname] * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * */ body: string; /** @example true */ featured: boolean; @@ -12559,17 +19911,13 @@ export interface components { "api-overview": { /** @example true */ verifiable_password_authentication: boolean; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ dependabot?: string[]; domains?: { website?: string[]; @@ -13014,47 +20362,47 @@ export interface components { /** * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; @@ -13137,12 +20485,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -13608,15 +20956,15 @@ export interface components { /** * @description An array of teams linked to this group * @example [ - * { - * "team_id": 1, - * "team_name": "team-test" - * }, - * { - * "team_id": 2, - * "team_name": "team-test2" - * } - * ] + * { + * "team_id": 1, + * "team_name": "team-test" + * }, + * { + * "team_id": 2, + * "team_name": "team-test2" + * } + * ] */ teams: { /** @@ -13633,19 +20981,19 @@ export interface components { /** * @description An array of external members linked to this group * @example [ - * { - * "member_id": 1, - * "member_login": "mona-lisa_eocsaxrs", - * "member_name": "Mona Lisa", - * "member_email": "mona_lisa@github.com" - * }, - * { - * "member_id": 2, - * "member_login": "octo-lisa_eocsaxrs", - * "member_name": "Octo Lisa", - * "member_email": "octo_lisa@github.com" - * } - * ] + * { + * "member_id": 1, + * "member_login": "mona-lisa_eocsaxrs", + * "member_name": "Mona Lisa", + * "member_email": "mona_lisa@github.com" + * }, + * { + * "member_id": 2, + * "member_login": "octo-lisa_eocsaxrs", + * "member_name": "Octo Lisa", + * "member_email": "octo_lisa@github.com" + * } + * ] */ members: { /** @@ -13678,17 +21026,17 @@ export interface components { /** * @description An array of external groups available to be mapped to a team * @example [ - * { - * "group_id": 1, - * "group_name": "group-azuread-test", - * "updated_at": "2021-01-03 22:27:15:000 -700" - * }, - * { - * "group_id": 2, - * "group_name": "group-azuread-test2", - * "updated_at": "2021-06-03 22:27:15:000 -700" - * } - * ] + * { + * "group_id": 1, + * "group_name": "group-azuread-test", + * "updated_at": "2021-01-03 22:27:15:000 -700" + * }, + * { + * "group_id": 2, + * "group_name": "group-azuread-test2", + * "updated_at": "2021-06-03 22:27:15:000 -700" + * } + * ] */ groups?: { /** @@ -13732,12 +21080,10 @@ export interface components { deliveries_url?: string; /** @example web */ name: string; - /** - * @example [ - * "push", - * "pull_request" - * ] - */ + /** @example [ + * "push", + * "pull_request" + * ] */ events: string[]; /** @example true */ active: boolean; @@ -13921,13 +21267,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the request for access was created. */ @@ -13957,13 +21303,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -14250,7 +21596,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -14283,7 +21629,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -14295,7 +21641,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -14316,69 +21662,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -14387,14 +21733,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -14601,14 +21947,12 @@ export interface components { open_issues_count: number; /** @example true */ is_template?: boolean; - /** - * @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] - */ + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ topics?: string[]; /** @example true */ has_issues: boolean; @@ -14670,8 +22014,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @example PR_TITLE * @enum {string} */ @@ -14679,9 +22023,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -14689,8 +22033,8 @@ export interface components { /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @example PR_TITLE * @enum {string} */ @@ -14698,9 +22042,9 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -14725,7 +22069,7 @@ export interface components { * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; + anonymous_access_enabled: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; }; @@ -15513,7 +22857,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -15551,7 +22895,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -15572,44 +22916,44 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - allow_forking?: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -15954,10 +23298,10 @@ export interface components { /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ - * "self-hosted", - * "foo", - * "bar" - * ] + * "self-hosted", + * "foo", + * "bar" + * ] */ labels: string[]; /** @@ -16051,9 +23395,9 @@ export interface components { "actions-workflow-access-to-repository": { /** * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the - * repository. + * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. * @enum {string} */ access_level: "none" | "user" | "organization" | "enterprise"; @@ -16425,14 +23769,11 @@ export interface components { * @example deploy */ task: string; - payload: OneOf< - [ - { + payload: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** @example staging */ original_environment?: string; /** @@ -16631,7 +23972,7 @@ export interface components { * @default false * @example true */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; }; /** * Branch Restriction Policy @@ -16778,12 +24119,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -16971,11 +24312,9 @@ export interface components { url: string; /** @example true */ strict: boolean; - /** - * @example [ - * "continuous-integration/travis-ci" - * ] - */ + /** @example [ + * "continuous-integration/travis-ci" + * ] */ contexts: string[]; checks: { /** @example continuous-integration/travis-ci */ @@ -17006,7 +24345,7 @@ export interface components { * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; dismissal_restrictions?: { /** Format: uri */ url: string; @@ -17057,12 +24396,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -17440,12 +24779,12 @@ export interface components { * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; + "code-scanning-analysis-url": string; "code-scanning-analysis": { ref: components["schemas"]["code-scanning-ref"]; commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; @@ -17480,12 +24819,12 @@ export interface components { * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + readonly next_analysis_url: string | null; /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; + readonly confirm_delete_url: string | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { @@ -17543,10 +24882,8 @@ export interface components { )[]; [key: string]: unknown; }; - /** - * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. - * You should not rely on this always being an actions workflow run object. - */ + /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. + * You should not rely on this always being an actions workflow run object. */ "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ run_id?: number; @@ -17555,7 +24892,7 @@ export interface components { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -17567,7 +24904,7 @@ export interface components { * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; + readonly url?: string; }; "code-scanning-sarifs-status": { /** @@ -17579,9 +24916,9 @@ export interface components { * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** * CODEOWNERS errors @@ -17618,8 +24955,8 @@ export interface components { * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: * - * * user - * ^ + * * user + * ^ */ message: string; /** @@ -18354,10 +25691,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -18497,19 +25834,19 @@ export interface components { name?: string; /** * @description The version of the package. If the package does not have an exact version specified, - * a version range is given. + * a version range is given. * @example 1.0.0 */ versionInfo?: string; /** * @description The location where the package can be downloaded, - * or NOASSERTION if this has not been determined. + * or NOASSERTION if this has not been determined. * @example NOASSERTION */ downloadLocation?: string; /** * @description Whether the package's file content has been subjected to - * analysis during the creation of the SPDX document. + * analysis during the creation of the SPDX document. * @example false */ filesAnalyzed?: boolean; @@ -18520,7 +25857,7 @@ export interface components { licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information - * was not available when the SPDX document was created. + * was not available when the SPDX document was created. * @example NOASSERTION */ licenseDeclared?: string; @@ -18554,7 +25891,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: (string | number | boolean) | null; + [key: string]: ((string | number | boolean) | null) | undefined; }; dependency: { /** @@ -18597,7 +25934,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"]; + [key: string]: components["schemas"]["dependency"] | undefined; }; }; /** @@ -18655,7 +25992,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"]; + [key: string]: components["schemas"]["manifest"] | undefined; }; /** * Format: date-time @@ -18703,7 +26040,7 @@ export interface components { * @default * @example production */ - environment?: string; + environment: string; /** * Format: uri * @description Deprecated: the URL to associate with this status. @@ -18737,14 +26074,14 @@ export interface components { * @default * @example https://staging.example.com/ */ - environment_url?: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - log_url?: string; + log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** @@ -18852,8 +26189,8 @@ export interface components { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -18863,8 +26200,8 @@ export interface components { /** * @description The name pattern that branches must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -19094,43 +26431,43 @@ export interface components { /** * @description Objects specifying a tree structure * @example [ - * { - * "path": "file.rb", - * "mode": "100644", - * "type": "blob", - * "size": 30, - * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" + * { + * "path": "file.rb", + * "mode": "100644", + * "type": "blob", + * "size": 30, + * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", + * "properties": { + * "path": { + * "type": "string" + * }, + * "mode": { + * "type": "string" + * }, + * "type": { + * "type": "string" + * }, + * "size": { + * "type": "integer" + * }, + * "sha": { + * "type": "string" + * }, + * "url": { + * "type": "string" + * } + * }, + * "required": [ + * "path", + * "mode", + * "type", + * "sha", + * "url", + * "size" + * ] * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" * ] - * } - * ] */ tree: { /** @example test/file.rb */ @@ -19177,9 +26514,9 @@ export interface components { /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ - * "push", - * "pull_request" - * ] + * "push", + * "pull_request" + * ] */ events: string[]; config: components["schemas"]["webhook-config"]; @@ -19303,14 +26640,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -19320,9 +26656,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -20124,7 +27459,7 @@ export interface components { * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -20140,7 +27475,7 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} @@ -20266,7 +27601,7 @@ export interface components { * @description Language */ language: { - [key: string]: number; + [key: string]: number | undefined; }; /** * License Content @@ -20406,9 +27741,9 @@ export interface components { /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ - * "example.com", - * "www.example.com" - * ] + * "example.com", + * "www.example.com" + * ] */ domains: string[]; /** Format: date */ @@ -21189,13 +28524,13 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -21335,10 +28670,8 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -21534,17 +28867,15 @@ export interface components { * @description Commit Activity */ "commit-activity": { - /** - * @example [ - * 0, - * 3, - * 26, - * 20, - * 39, - * 1, - * 0 - * ] - */ + /** @example [ + * 0, + * 3, + * 26, + * 20, + * 39, + * 1, + * 0 + * ] */ days: number[]; /** @example 89 */ total: number; @@ -21559,16 +28890,14 @@ export interface components { author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ total: number; - /** - * @example [ - * { - * "w": "1367712000", - * "a": 6898, - * "d": 77, - * "c": 10 - * } - * ] - */ + /** @example [ + * { + * "w": "1367712000", + * "a": 6898, + * "d": 77, + * "c": 10 + * } + * ] */ weeks: { w?: number; a?: number; @@ -21661,8 +28990,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: ( | "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -21723,17 +29052,17 @@ export interface components { /** * @description The security group members. * @example [ - * { - * "value": "879db59-3bdf-4490-ad68-ab880a2694745", - * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - * "displayName": "User 1" - * }, - * { - * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - * "displayName": "User 2" - * } - * ] + * { + * "value": "879db59-3bdf-4490-ad68-ab880a2694745", + * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + * "displayName": "User 1" + * }, + * { + * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + * "displayName": "User 2" + * } + * ] */ members?: { value?: string; @@ -21746,8 +29075,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -21772,8 +29101,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:Group"[]; /** @@ -21881,8 +29210,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -21927,8 +29256,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -21993,8 +29322,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -22052,12 +29381,10 @@ export interface components { language?: string | null; /** Format: date-time */ last_modified_at?: string; - /** - * @example [ - * "73..77", - * "77..78" - * ] - */ + /** @example [ + * "73..77", + * "77..78" + * ] */ line_numbers?: string[]; text_matches?: components["schemas"]["search-result-text-matches"]; }; @@ -22722,36 +30049,32 @@ export interface components { key_id: string; /** @example xsBNBFayYZ... */ public_key: string; - /** - * @example [ - * { - * "email": "octocat@users.noreply.github.com", - * "verified": true - * } - * ] - */ + /** @example [ + * { + * "email": "octocat@users.noreply.github.com", + * "verified": true + * } + * ] */ emails: { email?: string; verified?: boolean; }[]; - /** - * @example [ - * { - * "id": 4, - * "primary_key_id": 3, - * "key_id": "4A595D4C72EE49C7", - * "public_key": "zsBNBFayYZ...", - * "emails": [], - * "can_sign": false, - * "can_encrypt_comms": true, - * "can_encrypt_storage": true, - * "can_certify": false, - * "created_at": "2016-03-24T11:31:04-06:00", - * "expires_at": null, - * "revoked": false - * } - * ] - */ + /** @example [ + * { + * "id": 4, + * "primary_key_id": 3, + * "key_id": "4A595D4C72EE49C7", + * "public_key": "zsBNBFayYZ...", + * "emails": [], + * "can_sign": false, + * "can_encrypt_comms": true, + * "can_encrypt_storage": true, + * "can_certify": false, + * "created_at": "2016-03-24T11:31:04-06:00", + * "expires_at": null, + * "revoked": false + * } + * ] */ subkeys: { id?: number; primary_key_id?: number; @@ -22853,8 +30176,9 @@ export interface components { /** * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured - * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts)." + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.10/admin/overview/about-enterprise-accounts)." + * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -22902,8 +30226,8 @@ export interface components { /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured - * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * for and sent to a GitHub App. For more information, + * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -22920,7 +30244,7 @@ export interface components { /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an - * organization, or when the event occurs from activity in a repository owned by an organization. + * organization, or when the event occurs from activity in a repository owned by an organization. */ "organization-simple-webhooks": { /** @example github */ @@ -22960,7 +30284,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "repository-webhooks": { /** @@ -23162,7 +30486,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -23194,7 +30518,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -23206,7 +30530,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -23227,7 +30551,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -23337,34 +30661,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -23378,62 +30702,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -23442,14 +30766,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -24029,8 +31353,8 @@ export interface components { repository_url: string; /** * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. * @enum {string} */ state: "open" | "closed" | "locked" | "converting" | "transferring"; @@ -25417,7 +32741,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** @@ -25619,7 +32943,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -25651,7 +32975,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -25663,7 +32987,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -25684,7 +33008,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -25794,34 +33118,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -25835,62 +33159,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -25899,14 +33223,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -26048,37 +33372,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ permissions_added: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @@ -26337,41 +33661,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -26379,7 +33703,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; /** Pull Request */ webhooks_pull_request_5: { @@ -26584,24 +33908,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -26637,7 +33961,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -26721,17 +34045,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -26798,7 +34122,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -26806,17 +34130,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -26848,7 +34172,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -26924,24 +34248,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -26977,7 +34301,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -27061,17 +34385,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -27138,7 +34462,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -27146,17 +34470,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -27188,7 +34512,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -27378,9 +34702,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -27415,8 +34738,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -27466,9 +34789,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -30026,7 +37348,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: Record | null; + dismissed_by: Record; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -31058,7 +38380,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -31377,7 +38699,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -31735,7 +39057,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -32065,7 +39387,7 @@ export interface components { id: number; node_id: string; original_environment: string; - payload: string | Record | null; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -33073,24 +40395,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -33130,7 +40452,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -33269,7 +40591,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -33352,7 +40674,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: Record | null; + license?: Record; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -34211,7 +41533,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34238,10 +41560,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -34800,7 +42122,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34827,10 +42149,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -35392,7 +42714,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -35419,10 +42741,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -35964,8 +43286,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -35975,13 +43297,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -39408,24 +46730,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -39461,7 +46783,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -39602,7 +46924,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -41092,24 +48414,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -41145,7 +48467,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -41289,7 +48611,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -41904,12 +49226,10 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { - /** - * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - * assigned to the collaborator, use the `role_name` field instead, which will provide the full - * role name, including custom roles. - */ + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; @@ -42343,11 +49663,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string; + [key: string]: string | undefined; }; repo?: string; dependencies?: { - [key: string]: string; + [key: string]: string | undefined; }[]; commit_oid?: string; }; @@ -42447,8 +49767,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -42473,19 +49793,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: Record | null; - bugs?: Record | null; + author?: Record; + bugs?: Record; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: Record | null; + dist?: Record; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: Record | null; + repository?: Record; scripts?: Record; id?: string; node_version?: string; @@ -42498,7 +49818,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: Record | null; + directories?: Record; os?: string[]; cpu?: string[]; readme?: string; @@ -42512,19 +49832,16 @@ export interface components { | { id?: number | string; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -43401,22 +50718,19 @@ export interface components { "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; - changes?: OneOf< - [ - { + changes?: + | { field_value: { field_node_id?: string; field_type?: string; }; - }, - { + } + | { body: { from?: string | null; to?: string | null; }; - }, - ] - >; + }; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; @@ -43676,24 +50990,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -43729,7 +51043,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -43813,17 +51127,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -43890,7 +51204,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -43898,9 +51212,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -43910,8 +51224,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -43943,7 +51257,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -44019,24 +51333,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -44072,7 +51386,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -44156,17 +51470,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -44233,7 +51547,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -44241,9 +51555,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -44253,8 +51567,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -44286,7 +51600,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -44476,9 +51790,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -44513,8 +51826,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -44564,9 +51877,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -44888,24 +52200,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -44941,7 +52253,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -45025,17 +52337,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -45102,7 +52414,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -45110,9 +52422,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -45122,8 +52434,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -45155,7 +52467,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45231,24 +52543,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -45284,7 +52596,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -45368,17 +52680,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -45445,7 +52757,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -45453,9 +52765,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -45465,8 +52777,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -45498,7 +52810,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45688,9 +53000,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45725,8 +53036,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -45776,9 +53087,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -46101,24 +53411,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46154,7 +53464,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46238,17 +53548,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46315,7 +53625,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46323,9 +53633,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46335,8 +53645,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46368,7 +53678,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46444,24 +53754,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46497,7 +53807,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46581,17 +53891,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46658,7 +53968,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46666,9 +53976,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46678,8 +53988,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46711,7 +54021,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46901,9 +54211,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -46938,8 +54247,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -46989,9 +54298,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -47382,24 +54690,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47435,7 +54743,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47519,17 +54827,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47596,7 +54904,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47604,9 +54912,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47616,8 +54924,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47649,7 +54957,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -47725,24 +55033,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47778,7 +55086,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47862,17 +55170,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47939,7 +55247,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47947,9 +55255,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47959,8 +55267,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47992,7 +55300,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48182,9 +55490,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48219,8 +55526,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -48270,9 +55577,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -48594,24 +55900,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48647,7 +55953,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48731,17 +56037,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48808,7 +56114,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48816,9 +56122,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48828,8 +56134,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48861,7 +56167,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48937,24 +56243,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48990,7 +56296,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49074,17 +56380,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49151,7 +56457,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49159,9 +56465,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -49171,8 +56477,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49204,7 +56510,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -49394,9 +56700,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49431,8 +56736,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -49482,9 +56787,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -50004,24 +57308,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50057,7 +57361,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50141,17 +57445,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50218,7 +57522,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50226,9 +57530,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50238,8 +57542,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50271,7 +57575,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50340,24 +57644,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50393,7 +57697,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50442,7 +57746,7 @@ export interface components { * @description Whether discussions are enabled. * @default false */ - has_discussions?: boolean; + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -50477,17 +57781,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50554,7 +57858,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50562,9 +57866,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50574,8 +57878,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50607,7 +57911,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50752,9 +58056,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50789,8 +58092,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -50840,9 +58143,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -51156,24 +58458,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51209,7 +58511,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51293,17 +58595,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51370,7 +58672,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51378,9 +58680,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51390,8 +58692,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51423,7 +58725,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51492,24 +58794,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51545,7 +58847,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51629,17 +58931,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51706,7 +59008,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51714,9 +59016,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51726,8 +59028,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51759,7 +59061,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51904,9 +59206,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51941,8 +59242,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -51992,9 +59293,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -52309,24 +59609,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52362,7 +59662,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52446,17 +59746,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52523,7 +59823,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52531,9 +59831,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52543,8 +59843,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52576,7 +59876,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52645,24 +59945,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52698,7 +59998,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52782,17 +60082,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52859,7 +60159,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52867,9 +60167,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52879,8 +60179,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52912,7 +60212,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53057,9 +60357,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53094,8 +60393,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -53145,9 +60444,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -53461,24 +60759,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53514,7 +60812,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53598,17 +60896,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53675,7 +60973,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53683,9 +60981,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53695,8 +60993,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53728,7 +61026,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53797,24 +61095,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53850,7 +61148,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53934,17 +61232,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -54011,7 +61309,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54019,9 +61317,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -54031,8 +61329,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -54064,7 +61362,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54209,9 +61507,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54246,8 +61543,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -54297,9 +61594,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -54700,24 +61996,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54753,7 +62049,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54892,7 +62188,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54987,24 +62283,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55040,7 +62336,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55179,7 +62475,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55350,9 +62646,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55387,8 +62682,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -55438,9 +62733,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -55547,9 +62841,8 @@ export interface components { sender: components["schemas"]["simple-user-webhooks"]; }; /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": OneOf< - [ - { + "webhook-pull-request-review-request-removed": + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -55760,24 +63053,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55813,7 +63106,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55897,17 +63190,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -55974,7 +63267,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56020,7 +63313,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56096,24 +63389,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56149,7 +63442,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56233,17 +63526,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56310,7 +63603,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56318,9 +63611,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -56330,8 +63623,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -56363,7 +63656,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56553,9 +63846,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56590,8 +63882,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -56641,9 +63933,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -56790,8 +64081,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -57002,24 +64293,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57055,7 +64346,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57139,17 +64430,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57216,7 +64507,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57224,9 +64515,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57236,8 +64527,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57269,7 +64560,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57345,24 +64636,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57398,7 +64689,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57482,17 +64773,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57559,7 +64850,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57567,9 +64858,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57579,8 +64870,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57612,7 +64903,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57802,9 +65093,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57839,8 +65129,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -57890,9 +65180,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -58057,13 +65346,10 @@ export interface components { url: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request review_requested event */ - "webhook-pull-request-review-requested": OneOf< - [ - { + "webhook-pull-request-review-requested": + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -58274,24 +65560,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58327,7 +65613,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58411,17 +65697,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58488,7 +65774,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58496,9 +65782,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58508,8 +65794,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58541,7 +65827,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58617,24 +65903,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58670,7 +65956,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58754,17 +66040,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58831,7 +66117,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58839,9 +66125,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58851,8 +66137,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58884,7 +66170,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59074,9 +66360,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -59111,8 +66396,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -59162,9 +66447,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -59311,8 +66595,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -59523,24 +66807,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59576,7 +66860,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59660,17 +66944,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59737,7 +67021,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59745,9 +67029,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59757,8 +67041,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -59790,7 +67074,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59866,24 +67150,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59919,7 +67203,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60003,17 +67287,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60080,7 +67364,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60088,9 +67372,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60100,8 +67384,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60133,7 +67417,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60323,9 +67607,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -60360,8 +67643,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -60411,9 +67694,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -60578,9 +67860,7 @@ export interface components { url?: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { /** @enum {string} */ @@ -60790,24 +68070,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60843,7 +68123,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60927,17 +68207,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -61004,7 +68284,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61012,9 +68292,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -61024,8 +68304,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -61057,7 +68337,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61126,24 +68406,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61179,7 +68459,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61263,17 +68543,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -61340,7 +68620,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61348,9 +68628,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -61360,8 +68640,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -61393,7 +68673,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61538,9 +68818,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -61575,8 +68854,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -61626,9 +68905,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -61943,24 +69221,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61996,7 +69274,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62140,7 +69418,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62237,24 +69515,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62290,7 +69568,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62434,7 +69712,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62607,9 +69885,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -62644,8 +69921,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -62695,9 +69972,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -63163,24 +70439,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63216,7 +70492,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63360,7 +70636,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63457,24 +70733,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63510,7 +70786,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63654,7 +70930,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63827,9 +71103,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -63864,8 +71139,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -63915,9 +71190,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -64387,24 +71661,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64440,7 +71714,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64524,17 +71798,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -64601,7 +71875,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64609,9 +71883,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64621,8 +71895,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64654,7 +71928,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -64730,24 +72004,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64783,7 +72057,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64937,7 +72211,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64945,9 +72219,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64957,8 +72231,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64990,7 +72264,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65180,9 +72454,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -65217,8 +72490,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -65268,9 +72541,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -65593,24 +72865,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65646,7 +72918,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65730,17 +73002,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65807,7 +73079,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65815,9 +73087,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65827,8 +73099,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65860,7 +73132,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65936,24 +73208,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65989,7 +73261,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66073,17 +73345,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66150,7 +73422,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66158,9 +73430,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66170,8 +73442,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66203,7 +73475,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66393,9 +73665,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -66430,8 +73701,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -66481,9 +73752,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -66806,24 +74076,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66859,7 +74129,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66943,17 +74213,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -67020,7 +74290,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67028,9 +74298,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67040,8 +74310,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -67073,7 +74343,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67149,24 +74419,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67202,7 +74472,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67356,7 +74626,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67364,9 +74634,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67376,8 +74646,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -67409,7 +74679,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67599,9 +74869,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -67636,8 +74905,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -67687,9 +74956,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -68011,24 +75279,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68064,7 +75332,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68148,17 +75416,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -68225,7 +75493,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68233,9 +75501,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -68245,8 +75513,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -68278,7 +75546,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68354,24 +75622,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68407,7 +75675,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68491,17 +75759,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -68568,7 +75836,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68576,9 +75844,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -68588,8 +75856,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -68621,7 +75889,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68811,9 +76079,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -68848,8 +76115,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -68899,9 +76166,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -69156,24 +76422,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69209,7 +76475,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -69353,7 +76619,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69450,8 +76716,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -69475,19 +76741,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: string | Record | null; - bugs?: string | Record | null; + author?: (string | Record) | null; + bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: string | Record | null; + dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: string | Record | null; + repository?: (string | Record) | null; scripts?: Record; id?: string; node_version?: string; @@ -69500,7 +76766,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: string | Record | null; + directories?: (string | Record) | null; os?: string[]; cpu?: string[]; readme?: string; @@ -69512,21 +76778,18 @@ export interface components { } | null; nuget_metadata?: | { - id?: string | Record | number | null; + id?: (string | Record | number) | null; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -69723,7 +76986,7 @@ export interface components { updated_at: string; version: string; }; - registry: Record | null; + registry: Record; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -70802,24 +78065,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70855,7 +78118,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70994,7 +78257,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71047,24 +78310,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71100,7 +78363,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71239,7 +78502,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71292,24 +78555,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71345,7 +78608,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71484,7 +78747,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71568,24 +78831,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71621,7 +78884,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71760,7 +79023,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71813,24 +79076,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71866,7 +79129,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72005,7 +79268,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -72185,7 +79448,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: (Record | null)[]; + steps?: Record[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -73806,18 +81069,27 @@ export interface components { responses: { /** @description Resource not found */ not_found: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Bad Request */ bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -73825,40 +81097,61 @@ export interface components { }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ accepted: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description Not modified */ not_modified: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Requires authentication */ requires_authentication: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Gone */ gone: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response */ actions_runner_jitconfig: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { runner: components["schemas"]["runner"]; @@ -73869,6 +81162,9 @@ export interface components { }; /** @description Response */ actions_runner_labels: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -73878,6 +81174,9 @@ export interface components { }; /** @description Response */ actions_runner_labels_readonly: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -73887,6 +81186,9 @@ export interface components { }; /** @description Service unavailable */ service_unavailable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -73897,12 +81199,18 @@ export interface components { }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden Gist */ forbidden_gist: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { block?: { @@ -73917,66 +81225,102 @@ export interface components { }; /** @description Moved permanently */ moved_permanently: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Conflict */ conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal Error */ internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description A header with no content is returned. */ no_content: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Temporary Redirect */ temporary_redirect: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if there is already a validation run in progress with a different default setup configuration */ code_scanning_conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Found */ found: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ dependency_review_forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unacceptable */ unacceptable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad request */ scim_bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -73984,14 +81328,23 @@ export interface components { }; /** @description Authorization failure */ authorization_failure: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Permission denied */ permission_denied: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Too many requests */ scim_too_many_requests: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -73999,6 +81352,9 @@ export interface components { }; /** @description Internal server error */ scim_internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -74006,18 +81362,21 @@ export interface components { }; /** @description Duplicate record detected */ duplicate_record_detected: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; parameters: { /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "per-page"?: number; + "per-page": number; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: number; + page: number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction?: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The unique identifier of the team. */ @@ -74033,10 +81392,10 @@ export interface components { /** @description The unique identifier of the token. */ "token-id": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: string; + cursor: string; "delivery-id": number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: string; + since: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The unique identifier of the grant. */ @@ -74053,7 +81412,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization"?: string; + "visible-to-organization": string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -74061,136 +81420,116 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase"?: string; - /** - * @description The event types to include: + "audit-log-enterprise-phrase": string; + /** @description The event types to include: * - * - `web` - returns web (non-Git) events. - * - `git` - returns Git events. - * - `all` - returns both web and Git events. + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. * - * The default is `web`. - */ - "audit-log-include"?: "web" | "git" | "all"; + * The default is `web`. */ + "audit-log-include": "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after"?: string; + "audit-log-after": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before"?: string; - /** - * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + "audit-log-before": string; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * - * The default is `desc`. - */ - "audit-log-order"?: "desc" | "asc"; + * The default is `desc`. */ + "audit-log-order": "desc" | "asc"; /** @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. */ - "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @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. */ - "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; + "pagination-before": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + "pagination-after": string; + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - "dependabot-alert-comma-separated-states"?: string; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ + "dependabot-alert-comma-separated-states": string; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * - * Can be: `low`, `medium`, `high`, `critical` - */ - "dependabot-alert-comma-separated-severities"?: string; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * Can be: `low`, `medium`, `high`, `critical` */ + "dependabot-alert-comma-separated-severities": string; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - "dependabot-alert-comma-separated-ecosystems"?: string; + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ + "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages"?: string; + "dependabot-alert-comma-separated-packages": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope"?: "development" | "runtime"; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - */ - "dependabot-alert-sort"?: "created" | "updated"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first"?: number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last"?: number; + "dependabot-alert-scope": "development" | "runtime"; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ + "dependabot-alert-sort": "created" | "updated"; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ + "pagination-first": number; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ + "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ - "secret-scanning-alert-secret-type"?: string; + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution"?: string; + "secret-scanning-alert-resolution": string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort"?: "created" | "updated"; + "secret-scanning-alert-sort": "created" | "updated"; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" | "dependabot_alerts" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the enterprise. - * `disable_all` means to disable the specified security feature for all repositories in the enterprise. - */ + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ "enterprise-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: string; + labels: string; /** @description The UUID which identifies a node. */ - uuid?: string; + uuid: string; /** @description The cluster roles from the cluster configuration file. */ - "cluster-roles"?: string; + "cluster-roles": string; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all?: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: string; + before: string; /** @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/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org"?: number; + "since-org": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository"?: string; + "visible-to-repository": string; /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "variables-per-page"?: number; + "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase"?: string; + "audit-log-phrase": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The unique identifier of the group. */ @@ -74199,13 +81538,11 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - */ - "package-visibility"?: "public" | "private" | "internal"; + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ + "package-visibility": "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ "package-type": | "npm" @@ -74219,23 +81556,23 @@ export interface components { /** @description Unique identifier of the package version. */ "package-version-id": number; /** @description The property by which to sort the results. */ - "personal-access-token-sort"?: "created_at"; + "personal-access-token-sort": "created_at"; /** @description A list of owner usernames to use to filter the results. */ - "personal-access-token-owner"?: string[]; + "personal-access-token-owner": string[]; /** @description The name of the repository to use to filter the results. */ - "personal-access-token-repository"?: string; + "personal-access-token-repository": string; /** @description The permission to use to filter the results. */ - "personal-access-token-permission"?: string; + "personal-access-token-permission": string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-before"?: string; + "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-after"?: string; + "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo"?: string; + "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo"?: string; + "secret-scanning-pagination-after-org-repo": string; /** @description The slug of the team name. */ "team-slug": string; /** @description The number that identifies the discussion. */ @@ -74255,27 +81592,25 @@ export interface components { | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the card. */ "card-id": number; /** @description The unique identifier of the column. */ "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - "artifact-name"?: string; + "artifact-name": string; /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full"?: string; + "actions-cache-git-ref-full": string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key"?: string; + "actions-cache-key": string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort"?: + "actions-cache-list-sort": | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -74286,13 +81621,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch"?: string; + "workflow-run-branch": string; /** @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/enterprise-server@3.10/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: string; + event: string; /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ - "workflow-run-status"?: + "workflow-run-status": | "completed" | "action_required" | "cancelled" @@ -74308,13 +81643,13 @@ export interface components { | "waiting" | "pending"; /** @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/enterprise-server@3.10/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests"?: boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id"?: number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha"?: string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -74330,11 +81665,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name"?: string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - status?: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @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`. */ - "git-ref"?: components["schemas"]["code-scanning-ref"]; + "git-ref": components["schemas"]["code-scanning-ref"]; /** @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. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -74342,16 +81677,14 @@ export interface components { /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ "commit-ref": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests"?: string; - /** - * @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. - */ + "dependabot-alert-comma-separated-manifests": string; + /** @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. */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path"?: string; + "manifest-path": string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ @@ -74368,7 +81701,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort?: "created" | "updated"; + sort: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -74386,31 +81719,31 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo"?: number; + "since-repo": number; /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ - "excluded-attributes"?: string; + "excluded-attributes": string; /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ - "start-index"?: number; + "start-index": number; /** @description Used for pagination: the number of results to return per page. */ - count?: number; + count: number; /** @description A unique identifier of the SCIM group. */ "scim-group-id": string; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: "desc" | "asc"; + order: "desc" | "asc"; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "since-repo-date"?: string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date"?: string; + "before-repo-date": string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred"?: "created" | "updated"; + "sort-starred": "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user"?: number; + "since-user": number; }; requestBodies: never; headers: { @@ -74431,39 +81764,47 @@ export interface components { }; pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - /** - * GitHub API Root - * @description Get Hypermedia links to resources accessible in GitHub's REST API - */ "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["root"]; }; }; }; }; - /** List global webhooks */ "enterprise-admin/list-global-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["global-hook"][]; @@ -74471,8 +81812,13 @@ export interface operations { }; }; }; - /** Create a global webhook */ "enterprise-admin/create-global-webhook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -74502,51 +81848,68 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Get a global webhook */ "enterprise-admin/get-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Delete a global webhook */ "enterprise-admin/delete-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a global webhook - * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. - */ "enterprise-admin/update-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -74575,46 +81938,60 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook-2"]; }; }; }; }; - /** - * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the webhook. - */ "enterprise-admin/ping-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List public keys */ "enterprise-admin/list-public-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "accessed"; /** @description Only show public keys accessed after the given time. */ since?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["public-key-full"][]; @@ -74622,29 +81999,36 @@ export interface operations { }; }; }; - /** Delete a public key */ "enterprise-admin/delete-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_ids: components["parameters"]["key-ids"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. - */ "enterprise-admin/update-ldap-mapping-for-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -74657,25 +82041,32 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ldap-mapping-team"]; }; }; }; }; - /** - * Sync LDAP mapping for a team - * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. - */ "enterprise-admin/sync-ldap-mapping-for-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { status?: string; @@ -74684,12 +82075,15 @@ export interface operations { }; }; }; - /** Update LDAP mapping for a user */ "enterprise-admin/update-ldap-mapping-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -74702,25 +82096,32 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ldap-mapping-user"]; }; }; }; }; - /** - * Sync LDAP mapping for a user - * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. - */ "enterprise-admin/sync-ldap-mapping-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { status?: string; @@ -74729,8 +82130,13 @@ export interface operations { }; }; }; - /** Create an organization */ "enterprise-admin/create-org": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -74746,18 +82152,24 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-simple"]; }; }; }; }; - /** Update an organization name */ "enterprise-admin/update-org-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -74770,6 +82182,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74779,27 +82194,41 @@ export interface operations { }; }; }; - /** List pre-receive environments */ "enterprise-admin/list-pre-receive-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "name"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"][]; }; }; }; }; - /** Create a pre-receive environment */ "enterprise-admin/create-pre-receive-environment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -74813,51 +82242,62 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** Get a pre-receive environment */ "enterprise-admin/get-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** - * Delete a pre-receive environment - * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ - */ "enterprise-admin/delete-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74871,15 +82311,15 @@ export interface operations { }; }; }; - /** - * Update a pre-receive environment - * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. - */ "enterprise-admin/update-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -74894,12 +82334,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74913,32 +82359,32 @@ export interface operations { }; }; }; - /** - * Start a pre-receive environment download - * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. - * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ - */ "enterprise-admin/start-pre-receive-environment-download": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74952,47 +82398,65 @@ export interface operations { }; }; }; - /** - * Get the download status for a pre-receive environment - * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. - */ "enterprise-admin/get-download-status-for-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; }; }; - /** List pre-receive hooks */ "enterprise-admin/list-pre-receive-hooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "name"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"][]; }; }; }; }; - /** Create a pre-receive hook */ "enterprise-admin/create-pre-receive-hook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -75018,48 +82482,68 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** Get a pre-receive hook */ "enterprise-admin/get-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** Delete a pre-receive hook */ "enterprise-admin/delete-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a pre-receive hook */ "enterprise-admin/update-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -75086,28 +82570,34 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** - * List personal access tokens - * @description Lists personal access tokens for all users, including admin users. - */ "enterprise-admin/list-personal-access-tokens": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"][]; @@ -75115,42 +82605,42 @@ export interface operations { }; }; }; - /** - * Delete a personal access token - * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. - */ "enterprise-admin/delete-personal-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the token. */ token_id: components["parameters"]["token-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. - * - * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. - * - * If the login name or email address is already associated with an account, the server will return a `422` response. - */ "enterprise-admin/create-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { /** @description The user's username. */ login: string; - /** - * @description **Required for built-in authentication.** The user's email - * address. This parameter can be omitted when using CAS, LDAP, or SAML. - * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." - */ + /** @description **Required for built-in authentication.** The user's email + * address. This parameter can be omitted when using CAS, LDAP, or SAML. + * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." */ email?: string; /** * @description Whether to set the user as suspended when the user is created. @@ -75163,37 +82653,45 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"]; }; }; }; }; - /** - * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/users#suspend-a-user) is often a better option. - * - * You can delete any user account except your own. - */ "enterprise-admin/delete-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update the username for a user */ "enterprise-admin/update-username-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -75206,6 +82704,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -75215,12 +82716,15 @@ export interface operations { }; }; }; - /** Create an impersonation OAuth token */ "enterprise-admin/create-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -75233,61 +82737,81 @@ export interface operations { responses: { /** @description Response when getting an existing impersonation OAuth token */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; /** @description Response when creating a new impersonation OAuth token */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; }; }; - /** Delete an impersonation OAuth token */ "enterprise-admin/delete-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; }; }; }; - /** - * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ "apps/create-from-manifest": { parameters: { + query?: never; + header?: never; path: { code: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"] & { client_id: string; @@ -75302,29 +82826,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a webhook configuration for an app - * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an app - * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -75338,29 +82866,35 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an app webhook - * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -75369,21 +82903,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for an app webhook - * @description Returns a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -75392,38 +82927,41 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an app webhook - * @description Redeliver a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List installation requests for the authenticated app - * @description Lists all the pending installation requests for the authenticated GitHub App. - */ "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of integration installation requests */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration-installation-request"][]; }; @@ -75432,26 +82970,28 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List installations for the authenticated app - * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * The permissions the installation has are included under the `permissions` key. - */ "apps/list-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; outdated?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description The permissions the installation has are included under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -75599,11 +83139,11 @@ export interface operations { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ permissions: { /** @@ -75786,12 +83326,10 @@ export interface operations { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -75873,21 +83411,23 @@ export interface operations { }; }; }; - /** - * Get an installation for the authenticated app - * @description Enables an authenticated GitHub App to find an installation's information using the installation id. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -75895,43 +83435,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#suspend-an-app-installation)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/delete-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. - * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. - * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/create-installation-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -75941,8 +83475,8 @@ export interface operations { /** * @description List of repository IDs that the token should have access to * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -75952,6 +83486,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation-token"]; }; @@ -75962,67 +83499,71 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/suspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unsuspend an app installation - * @description Removes a GitHub App installation suspension. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/unsuspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List your grants - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. - */ "oauth-authorizations/list-grants": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The client ID of your GitHub app. */ client_id?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["application-grant"][]; @@ -76034,20 +83575,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a single grant - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-grant": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the grant. */ grant_id: components["parameters"]["grant-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["application-grant"]; }; @@ -76057,39 +83601,39 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a grant - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "oauth-authorizations/delete-grant": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the grant. */ grant_id: components["parameters"]["grant-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "apps/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76102,20 +83646,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. - */ "apps/check-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76128,6 +83675,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -76136,15 +83686,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. - */ "apps/delete-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76157,20 +83707,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ "apps/reset-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76183,6 +83736,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -76190,23 +83746,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a scoped access token - * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. - * - * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. - */ "apps/scope-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76231,8 +83779,8 @@ export interface operations { /** * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -76242,6 +83790,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -76252,19 +83803,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - */ "apps/get-by-slug": { parameters: { + query?: never; + header?: never; path: { app_slug: components["parameters"]["app-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; @@ -76273,25 +83827,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List your authorizations - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/list-authorizations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The client ID of your GitHub app. */ client_id?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"][]; @@ -76303,31 +83859,22 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a new authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. - * - * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use). - * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.10/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. - */ "oauth-authorizations/create-authorization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -76352,6 +83899,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -76364,24 +83912,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get-or-create an authorization for a specific app - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-or-create-authorization-for-app": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the OAuth app. */ client_id: components["parameters"]["oauth-client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76391,9 +83930,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -76414,6 +83953,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -76424,6 +83964,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -76435,23 +83976,16 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get-or-create an authorization for a specific app and fingerprint - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - */ "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the OAuth app. */ client_id: components["parameters"]["oauth-client-id"]; fingerprint: string; }; + cookie?: never; }; requestBody: { content: { @@ -76461,9 +83995,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -76482,6 +84016,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -76492,6 +84027,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -76500,20 +84036,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a single authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -76523,41 +84062,39 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete an authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Update an existing authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * You can only send one of these scope keys at a time. - */ "oauth-authorizations/update-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -76565,9 +84102,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @description A list of scopes to add to this authorization. */ @@ -76589,6 +84126,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -76596,14 +84136,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all codes of conduct - * @description Returns array of all GitHub's codes of conduct. - */ "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"][]; }; @@ -76611,19 +84157,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a code of conduct - * @description Returns information about the specified GitHub code of conduct. - */ "codes-of-conduct/get-conduct-code": { parameters: { + query?: never; + header?: never; path: { key: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"]; }; @@ -76632,54 +84181,74 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get emojis - * @description Lists all the emojis available to use on GitHub Enterprise Server. - */ "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { - [key: string]: string; + [key: string]: string | undefined; }; }; }; 304: components["responses"]["not_modified"]; }; }; - /** - * Get the global announcement banner - * @description Gets the current message and expiration date of the global announcement banner in your enterprise. - */ "enterprise-admin/get-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** - * Remove the global announcement banner - * @description Removes the global announcement banner in your enterprise. - */ "enterprise-admin/remove-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set the global announcement banner - * @description Sets the message and expiration time for the global announcement banner in your enterprise. - */ "enterprise-admin/set-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["announcement"]; @@ -76688,178 +84257,292 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** Get license information */ "enterprise-admin/get-license-information": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-info"]; }; }; }; }; - /** Get all statistics */ "enterprise-admin/get-all-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-overview"]; }; }; }; }; - /** Get comment statistics */ "enterprise-admin/get-comment-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-comment-overview"]; }; }; }; }; - /** Get gist statistics */ "enterprise-admin/get-gist-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-gist-overview"]; }; }; }; }; - /** Get hooks statistics */ "enterprise-admin/get-hooks-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-hook-overview"]; }; }; }; }; - /** Get issue statistics */ "enterprise-admin/get-issue-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-issue-overview"]; }; }; }; }; - /** Get milestone statistics */ "enterprise-admin/get-milestone-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-milestone-overview"]; }; }; }; }; - /** Get organization statistics */ "enterprise-admin/get-org-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-organization-overview"]; }; }; }; }; - /** Get pages statistics */ "enterprise-admin/get-pages-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-page-overview"]; }; }; }; }; - /** Get pull request statistics */ "enterprise-admin/get-pull-request-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-pull-request-overview"]; }; }; }; }; - /** Get repository statistics */ "enterprise-admin/get-repo-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-repository-overview"]; }; }; }; }; - /** - * Get security products statistics - * @description Gets the statistics about security products for a GitHub Enterprise Server instance. - * - * To use this endpoint, you must be a site admin. - */ "enterprise-admin/get-security-products": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-security-products-overview"]; }; }; }; }; - /** Get users statistics */ "enterprise-admin/get-user-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-user-overview"]; }; }; }; }; - /** - * Get GitHub Actions cache usage for an enterprise - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -76867,23 +84550,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage policy for an enterprise - * @description Gets the GitHub Actions cache usage policy for an enterprise. - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-actions-cache-usage-policy-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-policy-enterprise"]; @@ -76891,17 +84574,15 @@ export interface operations { }; }; }; - /** - * Set GitHub Actions cache usage policy for an enterprise - * @description Sets the GitHub Actions cache usage policy for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-actions-cache-usage-policy-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76911,42 +84592,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Actions permissions for an enterprise - * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-enterprise-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an enterprise - * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76959,29 +84643,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -76991,17 +84681,15 @@ export interface operations { }; }; }; - /** - * Set selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77014,82 +84702,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected organization for GitHub Actions in an enterprise - * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/enable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected organization for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/disable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an enterprise - * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an enterprise - * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77099,46 +84796,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an enterprise - * @description 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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an enterprise - * @description 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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77148,30 +84844,37 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an enterprise - * @description Lists all self-hosted runner groups for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this organization. */ visible_to_organization?: components["parameters"]["visible-to-organization"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -77181,17 +84884,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an enterprise - * @description Creates a new self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77225,66 +84926,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Get a self-hosted runner group for an enterprise - * @description Gets a specific self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an enterprise - * @description Deletes a self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an enterprise - * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -77315,32 +85024,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * List organization access to a self-hosted runner group in an enterprise - * @description Lists the organizations with access to a self-hosted runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -77350,18 +85066,17 @@ export interface operations { }; }; }; - /** - * Set organization access for a self-hosted runner group in an enterprise - * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77374,74 +85089,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add organization access to a self-hosted runner group in an enterprise - * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove organization access to a self-hosted runner group in an enterprise - * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an enterprise - * @description Lists the self-hosted runners that are in a specific enterprise group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -77452,18 +85180,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an enterprise - * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77476,73 +85203,85 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an enterprise - * @description Adds a self-hosted runner to a runner group configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an enterprise - * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an enterprise - * @description Lists all self-hosted runners configured for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -77553,38 +85292,38 @@ export interface operations { }; }; }; - /** - * List runner applications for an enterprise - * @description Lists binaries for the runner application that you can download and run. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for an Enterprise - * @description Generates a configuration that can be passed to the runner application at startup. - * - * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77609,138 +85348,129 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for an enterprise - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. - * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-registration-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an enterprise - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. - * - * Example using remove token: - * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-remove-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an enterprise - * @description Gets a specific self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an enterprise - * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an enterprise - * @description Lists all labels for a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an enterprise - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77756,18 +85486,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an enterprise - * @description Add custom labels to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77783,114 +85512,128 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an enterprise - * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an enterprise - * @description 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. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get the audit log for an enterprise - * @description Gets the audit log for an enterprise. - * - * The authenticated user must be an enterprise admin to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-enterprise-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an enterprise - * @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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. - */ "code-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -77900,23 +85643,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get code security and analysis features for an enterprise - * @description Gets code security and analysis settings for the specified enterprise. - * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/get-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-security-analysis-settings"]; }; @@ -77924,19 +85667,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update code security and analysis features for an enterprise - * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/patch-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody?: { content: { @@ -77949,10 +85688,8 @@ export interface operations { secret_scanning_enabled_for_new_repositories?: boolean; /** @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/enterprise-server@3.10/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; - /** - * @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/enterprise-server@3.10/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." - * To disable this functionality, set this field to `null`. - */ + /** @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/enterprise-server@3.10/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; }; }; @@ -77960,48 +85697,75 @@ export interface operations { responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * 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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. - */ "dependabot/list-alerts-for-enterprise": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -78012,32 +85776,42 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List secret scanning alerts for an enterprise - * @description 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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - */ "secret-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -78047,27 +85821,28 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get GitHub Advanced Security active committers for an enterprise - * @description 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. - */ "billing/get-github-advanced-security-billing-ghe": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; @@ -78075,48 +85850,61 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; }; }; - /** - * Enable or disable a security feature - * @description Enables or disables the specified security feature for all repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/post-security-product-enablement-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["enterprise-security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ enablement: components["parameters"]["enterprise-security-product-enablement"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. - */ "activity/list-public-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -78126,49 +85914,47 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get feeds - * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. - * - * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. - * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. - */ "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["feed"]; }; }; }; }; - /** - * List gists for the authenticated user - * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: - */ "gists/list": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -78178,13 +85964,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a gist - * @description Allows you to add a new gist with one or more files. - * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - */ "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -78196,16 +85982,18 @@ export interface operations { /** * @description Names and content for the files that make up the gist * @example { - * "hello.rb": { - * "content": "puts \"Hello, World!\"" - * } - * } + * "hello.rb": { + * "content": "puts \"Hello, World!\"" + * } + * } */ files: { - [key: string]: { - /** @description Content of the file */ - content: string; - }; + [key: string]: + | { + /** @description Content of the file */ + content: string; + } + | undefined; }; public?: boolean | ("true" | "false"); }; @@ -78217,6 +86005,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"]; @@ -78228,25 +86017,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List public gists - * @description List public gists sorted by most recently updated to least recently updated. - * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - */ "gists/list-public": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -78257,23 +86048,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List starred gists - * @description List the authenticated user's starred gists: - */ "gists/list-starred": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -78284,24 +86079,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a gist - * @description Gets a specified gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -78311,32 +86105,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist */ "gists/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist - * @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. - */ "gists/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78348,23 +86149,25 @@ export interface operations { description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. + * (including extension) of the targeted gist file. For example: `hello.py`. * - * To delete a file, set the whole file to null. For example: `hello.py : null`. + * To delete a file, set the whole file to null. For example: `hello.py : null`. * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } */ files?: { - [key: string]: { - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - }; + [key: string]: + | { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + } + | undefined; }; } | null; }; @@ -78372,6 +86175,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -78380,30 +86186,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List gist comments - * @description Lists the comments on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/list-comments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"][]; @@ -78414,20 +86218,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a gist comment - * @description Creates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78446,6 +86245,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"]; @@ -78456,25 +86256,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist comment - * @description Gets a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -78484,39 +86284,43 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist comment */ "gists/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist comment - * @description Updates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78532,6 +86336,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -78539,23 +86346,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist commits */ "gists/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-commit"][]; @@ -78566,22 +86379,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist forks */ "gists/list-forks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"][]; @@ -78592,19 +86411,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Fork a gist */ "gists/fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"]; @@ -78616,84 +86440,104 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Check if a gist is starred */ "gists/check-is-starred": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if gist is starred */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; }; }; - /** - * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "gists/star": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** Unstar a gist */ "gists/unstar": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist revision - * @description Gets a specified gist revision. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-revision": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -78703,14 +86547,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#create-a-repository-for-the-authenticated-user). - */ "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -78718,23 +86568,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a gitignore template - * @description Get the content of a gitignore template. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. - */ "gitignore/get-template": { parameters: { + query?: never; + header?: never; path: { name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gitignore-template"]; }; @@ -78742,22 +86591,25 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * List repositories accessible to the app installation - * @description List repositories that an app installation can access. - */ "apps/list-repos-accessible-to-installation": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -78773,38 +86625,24 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Revoke an installation access token - * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. - * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - */ "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List issues assigned to the authenticated user - * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list": { parameters: { query?: { @@ -78818,24 +86656,34 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; collab?: boolean; orgs?: boolean; owned?: boolean; pulls?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -78846,21 +86694,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get-all-commonly-used": { parameters: { query?: { featured?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-simple"][]; }; @@ -78868,19 +86721,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get": { parameters: { + query?: never; + header?: never; path: { license: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license"]; }; @@ -78890,71 +86746,98 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.10/admin/enterprise-management/configuring-clustering/about-clustering)." - */ "enterprise-admin/get-config-nodes": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-config-nodes"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the status of maintenance mode - * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." - */ "enterprise-admin/get-manage-maintenance": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-get-maintenance"]; }; }; /** @description Bad request */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set the status of maintenance mode - * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." - */ "enterprise-admin/set-manage-maintenance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["ghes-set-maintenance-request"]; @@ -78963,83 +86846,121 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-set-maintenance-response"]; }; }; /** @description Bad request */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the status of services running on all replica nodes - * @description Gets the status of all services running on each replica node. - * This endpoint may take several seconds to reply. - */ "enterprise-admin/get-replication-status": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-replication-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.10/admin/all-releases)." - */ "enterprise-admin/get-version": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-version"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Render a Markdown document */ "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -79065,6 +86986,7 @@ export interface operations { /** @example 279 */ "Content-Length"?: string; "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -79073,11 +86995,13 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Render a Markdown document in raw mode - * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - */ "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "text/plain": string; @@ -79089,6 +87013,7 @@ export interface operations { 200: { headers: { "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -79097,11 +87022,20 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** Get GitHub Enterprise Server meta information */ "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["api-overview"]; }; @@ -79109,21 +87043,30 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ "activity/list-public-events-for-repo-network": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -79134,27 +87077,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List notifications for the authenticated user - * @description List all notifications for the current user, sorted by most recently updated. - */ "activity/list-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -79166,11 +87115,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -79187,6 +87138,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -79195,26 +87149,33 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread - * @description Gets information about a notification thread. - */ "activity/get-thread": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread"]; }; @@ -79224,40 +87185,46 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Mark a thread as read - * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. - */ "activity/mark-thread-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#get-a-repository-subscription). - * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - */ "activity/get-thread-subscription-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -79267,19 +87234,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Set a thread subscription - * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. - * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#delete-a-thread-subscription) endpoint. - */ "activity/set-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -79295,6 +87258,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -79304,65 +87270,73 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. - */ "activity/delete-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.10/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get Octocat - * @description Get the octocat as ASCII art - */ "meta/get-octocat": { parameters: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/octocat-stream": string; }; }; }; }; - /** - * List organizations - * @description Lists all organizations, in the order that they were created. - * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. - */ "orgs/list": { parameters: { query?: { + /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -79371,28 +87345,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Deprecated - List custom repository roles in an organization - * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.10/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. - * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-roles": { parameters: { + query?: never; + header?: never; path: { /** @description The unique identifier of the organization. */ organization_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -79406,38 +87375,23 @@ export interface operations { }; }; }; - /** - * Get an organization - * @description Gets information about an organization. - * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.10/articles/securing-your-account-with-two-factor-authentication-2fa/). - * - * To see the full details about an organization, the authenticated user must be an organization owner. - * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. - * - * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. - */ "orgs/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -79445,54 +87399,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization - * @description Deletes an organization and all its repositories. - * - * The organization login will be unavailable for 90 days after deletion. - * - * Please review the Terms of Service regarding account deletion before using this endpoint: - * - * https://docs.github.com/enterprise-server@3.10/site-policy/github-terms/github-terms-of-service - */ "orgs/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server 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). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.10/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -79534,7 +87466,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -79555,53 +87487,41 @@ export interface operations { web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ blog?: string; - /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + /** @description Whether Dependabot alerts is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + /** @description Whether Dependabot security updates is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** - * @description Whether dependency graph is automatically enabled for new repositories. + /** @description Whether dependency graph is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning is automatically enabled for new repositories. + /** @description Whether secret scanning is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + /** @description Whether secret scanning push protection is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -79613,6 +87533,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -79620,6 +87543,9 @@ export interface operations { 409: components["responses"]["conflict"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -79628,24 +87554,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage for an organization - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -79653,28 +87578,28 @@ export interface operations { }; }; }; - /** - * List repositories with GitHub Actions cache usage for an organization - * @description Lists repositories and their 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-by-repo-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79685,38 +87610,38 @@ export interface operations { }; }; }; - /** - * Get the customization template for an OIDC subject claim for an organization - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "oidc/get-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A JSON serialized template for OIDC subject claim customization */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub"]; }; }; }; }; - /** - * Set the customization template for an OIDC subject claim for an organization - * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "oidc/update-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -79726,6 +87651,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -79734,40 +87662,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GitHub Actions permissions for an organization - * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-organization-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an organization - * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -79780,29 +87706,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -79812,18 +87744,15 @@ export interface operations { }; }; }; - /** - * Set selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-selected-repositories-enabled-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -79836,86 +87765,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/enable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/disable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an organization - * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an organization - * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -79925,46 +87859,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an organization - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an organization - * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -79974,34 +87907,44 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an organization - * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runner-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ visible_to_repository?: components["parameters"]["visible-to-repository"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80011,17 +87954,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an organization - * @description Creates a new self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/create-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80056,66 +87997,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Get a self-hosted runner group for an organization - * @description Gets a specific self-hosted runner group for an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an organization - * @description Deletes a self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-group-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an organization - * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/update-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80145,32 +88094,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * List repository access to a self-hosted runner group in an organization - * @description Lists the repositories with access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80180,18 +88136,17 @@ export interface operations { }; }; }; - /** - * Set repository access for a self-hosted runner group in an organization - * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80204,74 +88159,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add repository access to a self-hosted runner group in an organization - * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove repository access to a self-hosted runner group in an organization - * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an organization - * @description Lists self-hosted runners that are in a specific organization group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runners-in-group-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -80282,18 +88250,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an organization - * @description Replaces the list of self-hosted runners that are part of an organization runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-self-hosted-runners-in-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80306,75 +88273,85 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an organization - * @description Adds a self-hosted runner to a runner group configured in an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-self-hosted-runner-to-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an organization - * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-self-hosted-runner-from-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an organization - * @description Lists all self-hosted runners configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-self-hosted-runners-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -80385,42 +88362,38 @@ export interface operations { }; }; }; - /** - * List runner applications for an organization - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-runner-applications-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for an organization - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the organization. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80445,145 +88418,129 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for an organization - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an organization - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an organization - * @description Gets a specific self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/get-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an organization - * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an organization - * @description Lists all labels for a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an organization - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-custom-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80599,20 +88556,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an organization - * @description Adds custom labels to a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80628,77 +88582,67 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an organization - * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an organization - * @description Remove a custom label from a self-hosted runner configured - * in an organization. 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. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-custom-label-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -80709,138 +88653,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "actions/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -80862,61 +88733,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80926,22 +88805,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -80954,91 +88828,97 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization variables - * @description Lists all organization variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81049,19 +88929,15 @@ export interface operations { }; }; }; - /** - * Create an organization variable - * @description Creates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -81083,72 +88959,74 @@ export interface operations { responses: { /** @description Response when creating a variable */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an organization variable - * @description Gets a specific variable in an organization. - * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-variable"]; }; }; }; }; - /** - * Delete an organization variable - * @description Deletes an organization variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an organization variable - * @description Updates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/update-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81170,33 +89048,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization variable - * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-variable": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81206,26 +89088,24 @@ export interface operations { }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set selected repositories for an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81238,118 +89118,135 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get announcement banner for organization - * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. - */ "announcement-banners/get-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Remove announcement banner from organization - * @description Removes the announcement banner currently set for the organization. - */ "announcement-banners/remove-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set announcement banner for organization - * @description Sets the announcement banner to display for the organization. - */ "announcement-banners/set-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -81359,65 +89256,77 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." - * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.10/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." - * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. - */ "orgs/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-org": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; @@ -81426,15 +89335,20 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -81444,23 +89358,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-repo-roles": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -81474,19 +89388,15 @@ export interface operations { }; }; }; - /** - * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/create-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -81496,6 +89406,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -81504,24 +89417,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/get-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -81529,43 +89443,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a custom repository role - * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/delete-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/update-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81575,6 +89486,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -81583,37 +89497,60 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List Dependabot alerts for an organization - * @description Lists Dependabot alerts for an organization. - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-org": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -81625,28 +89562,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81657,134 +89594,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "dependabot/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81806,57 +89674,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81866,20 +89746,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81892,79 +89769,92 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.10/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get list of conflicting packages during Docker migration for organization - * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -81973,73 +89863,84 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ "activity/list-public-org-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * Get an external group - * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/external-idp-group-info-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the group. */ group_id: components["parameters"]["group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List external groups in an organization - * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-external-idp-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description Page token */ page?: number; /** @description Limits the list to groups containing the text in the group name */ display_name?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["external-groups"]; @@ -82047,28 +89948,28 @@ export interface operations { }; }; }; - /** - * List organization webhooks - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"][]; @@ -82077,20 +89978,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization webhook - * @description Create a hook that posts payloads in JSON format. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82111,8 +90007,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -82129,6 +90025,7 @@ export interface operations { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"]; @@ -82138,26 +90035,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -82165,47 +90061,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82220,8 +90110,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -82237,6 +90127,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -82245,46 +90138,42 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for an organization - * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an organization - * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82299,36 +90188,40 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an organization webhook - * @description Returns a list of webhook deliveries for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -82337,26 +90230,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook delivery for an organization webhook - * @description Returns a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -82365,99 +90258,95 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an organization webhook - * @description Redeliver a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) - * to be sent to the hook. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an organization installation for the authenticated app - * @description Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-org-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. - */ "orgs/list-app-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -82468,22 +90357,6 @@ export interface operations { }; }; }; - /** - * List organization issues assigned to the authenticated user - * @description List issues in an organization assigned to the authenticated user. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-org": { parameters: { query?: { @@ -82497,23 +90370,33 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -82522,10 +90405,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization members - * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. - */ "orgs/list-members": { parameters: { query?: { @@ -82533,18 +90412,25 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -82553,69 +90439,88 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Check organization membership for a user - * @description Check if a user is, publicly or privately, a member of the organization. - */ "orgs/check-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if requester is an organization member and user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if requester is not an organization member */ 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization member - * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - */ "orgs/remove-member": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get organization membership for a user - * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. - */ "orgs/get-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -82624,32 +90529,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set organization membership for a user - * @description Only authenticated organization owners can add a member to the organization or update the member's role. - * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.10/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. - * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. - * - * **Rate limits** - * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. - */ "orgs/set-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. * @default member * @enum {string} */ @@ -82660,6 +90558,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -82668,51 +90569,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove organization membership for a user - * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - */ "orgs/remove-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List organization migrations - * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). - * - * A list of `repositories` is only returned for export migrations. - */ "migrations/list-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -82720,17 +90625,15 @@ export interface operations { }; }; }; - /** - * Start an organization migration - * @description Initiates the generation of a migration archive. - * - * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.10/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." - */ "migrations/start-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82785,6 +90688,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -82793,36 +90699,31 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization migration status - * @description Fetches the status of a migration. - * - * The `state` of a migration can be one of the following values: - * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ "migrations/get-status-for-org": { parameters: { query?: { /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** - * @description * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -82830,84 +90731,104 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download an organization migration archive - * @description Fetches the URL to a migration archive. - */ "migrations/download-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization migration archive - * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. - */ "migrations/delete-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. - */ "migrations/unlock-repo-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List repositories in an organization migration - * @description List all the repositories for this organization migration. - */ "migrations/list-repos-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -82916,27 +90837,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List outside collaborators for an organization - * @description List all users who are outside collaborators of an organization. - */ "orgs/list-outside-collaborators": { parameters: { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -82944,16 +90868,17 @@ export interface operations { }; }; }; - /** - * Convert an organization member to outside collaborator - * @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/enterprise-server@3.10/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-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." - */ "orgs/convert-member-to-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82969,39 +90894,56 @@ export interface operations { responses: { /** @description User is getting converted asynchronously */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description User was converted */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @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/enterprise-server@3.10/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Remove outside collaborator from an organization - * @description Removing a user from this list will remove them from all the organization's repositories. - */ "orgs/remove-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -83011,12 +90953,6 @@ export interface operations { }; }; }; - /** - * List packages for an organization - * @description Lists packages in an organization readable by the user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-organization": { parameters: { query: { @@ -83028,19 +90964,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -83050,112 +90997,120 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for an organization - * @description Gets a specific package in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for an organization - * @description Restores an entire package in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-org": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by an organization - * @description Lists package versions for a package owned by an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -83165,116 +91120,131 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for an organization - * @description Gets a specific package version in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for an organization - * @description Restores a specific package version in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-requests": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; @@ -83286,17 +91256,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-requests-in-bulk": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83321,19 +91289,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-request": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; requestBody: { content: { @@ -83356,29 +91322,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-request-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -83389,34 +91356,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grants": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant"][]; @@ -83428,17 +91403,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-accesses": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83461,18 +91434,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-access": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the fine-grained personal access token. */ pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -83493,29 +91465,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the fine-grained personal access token. */ pat_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -83526,79 +91499,99 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List pre-receive hooks for an organization - * @description List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. - */ "enterprise-admin/list-pre-receive-hooks-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The sort order for the response collection. */ sort?: "created" | "updated" | "name"; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"][]; }; }; }; }; - /** Get a pre-receive hook for an organization */ "enterprise-admin/get-pre-receive-hook-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * Remove pre-receive hook enforcement for an organization - * @description Removes any overrides for this hook at the org level for this org. - */ "enterprise-admin/remove-pre-receive-hook-enforcement-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * Update pre-receive hook enforcement for an organization - * @description For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration` - */ "enterprise-admin/update-pre-receive-hook-enforcement-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83613,33 +91606,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-org": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -83648,15 +91647,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83671,6 +91670,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -83682,25 +91684,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public organization members - * @description Members of an organization can choose to have their membership publicized or not. - */ "orgs/list-public-members": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -83708,73 +91713,83 @@ export interface operations { }; }; }; - /** - * Check public organization membership for a user - * @description Check if the provided user is a public member of the organization. - */ "orgs/check-public-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a public member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a public member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set public organization membership for the authenticated user - * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "orgs/set-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Remove public organization membership for the authenticated user - * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. - */ "orgs/remove-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization repositories - * @description 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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/list-for-org": { parameters: { query?: { @@ -83791,18 +91806,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -83810,17 +91832,15 @@ export interface operations { }; }; }; - /** - * Create an organization repository - * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83838,7 +91858,7 @@ export interface operations { private?: boolean; /** * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.10/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. - * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. * @enum {string} */ visibility?: "public" | "private" | "internal"; @@ -83913,34 +91933,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -83953,6 +91973,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -83962,59 +91983,67 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-repo-fine-grained-permissions": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-fine-grained-permission"][]; }; }; }; }; - /** - * List secret scanning alerts for an organization - * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-org": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -84024,100 +92053,104 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "orgs/list-security-manager-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - /** - * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/add-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The organization has reached the maximum number of security manager teams. */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/remove-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Advanced Security active committers for an organization - * @description 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. - */ "billing/get-github-advanced-security-billing-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; @@ -84125,25 +92158,28 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; }; }; - /** - * List teams - * @description Lists all teams in an organization that are visible to the authenticated user. - */ "teams/list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -84152,17 +92188,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a team - * @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/enterprise-server@3.10/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/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/about-teams)". - */ "teams/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84177,21 +92211,21 @@ export interface operations { repo_names?: string[]; /** * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` * @enum {string} */ notification_setting?: @@ -84213,6 +92247,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -84221,22 +92258,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a team by name - * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. - */ "teams/get-by-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -84244,40 +92284,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team - * @description To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - */ "teams/delete-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a team - * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - */ "teams/update-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84288,18 +92328,18 @@ export interface operations { description?: string; /** * @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: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -84319,12 +92359,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -84334,33 +92380,34 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Pinned discussions only filter */ pinned?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -84368,22 +92415,17 @@ export interface operations { }; }; }; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -84403,75 +92445,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84486,38 +92533,43 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -84525,23 +92577,19 @@ export interface operations { }; }; }; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * **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`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -84554,78 +92602,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -84638,20 +92694,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { @@ -84665,21 +92716,31 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -84687,24 +92748,21 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -84728,51 +92786,53 @@ export interface operations { responses: { /** @description Response when the reaction type has already been added to this team discussion comment */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { @@ -84786,20 +92846,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -84807,23 +92876,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -84847,96 +92912,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List a connection between an external group and a team - * @description Lists a connection between a team and an external group. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-linked-external-idp-groups-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-groups"]; }; }; }; }; - /** - * Remove the connection between an external group and a team - * @description Deletes a connection between a team and an external group. - * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update the connection between an external group and a team - * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/link-external-idp-group-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -84952,36 +93031,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List team members - * @description Team members will include the members of child teams. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/list-members-in-org": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -84989,61 +93073,53 @@ export interface operations { }; }; }; - /** - * Get team membership for a user - * @description Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). - */ "teams/get-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ 404: { - content: never; - }; - }; - }; - /** - * Add or update team membership for a user - * @description 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/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. - * - * If 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. - * - * **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}`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-or-update-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85060,71 +93136,85 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user - * @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. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/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}`. - */ "teams/remove-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ "teams/list-projects-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -85132,46 +93222,53 @@ export interface operations { }; }; }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/check-permissions-for-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/add-or-update-project-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85187,10 +93284,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -85200,49 +93303,55 @@ export interface operations { }; }; }; - /** - * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/remove-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team repositories - * @description Lists a team's repositories visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - */ "teams/list-repos-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -85250,60 +93359,64 @@ export interface operations { }; }; }; - /** - * Check team permissions for a repository - * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. - * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/check-permissions-for-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with repository permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team does not have permission for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions - * @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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **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/enterprise-server@3.10/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". - */ "teams/add-or-update-repo-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85319,54 +93432,64 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a repository from a team - * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/remove-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams - * @description Lists the child teams of the team specified by `{team_slug}`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - */ "teams/list-child-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -85374,46 +93497,58 @@ export interface operations { }; }; }; - /** - * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ enablement: components["parameters"]["org-security-product-enablement"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a project card - * @description Gets information about a project card. - */ "projects/get-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -85424,25 +93559,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project card - * @description Deletes a project card - */ "projects/delete-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -85454,12 +93596,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ "projects/update-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85480,6 +93625,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -85491,12 +93639,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ "projects/move-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -85517,6 +93668,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -85525,6 +93679,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -85541,6 +93698,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -85555,19 +93715,23 @@ export interface operations { }; }; }; - /** - * Get a project column - * @description Gets information about a project column. - */ "projects/get-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -85578,32 +93742,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project column - * @description Deletes a project column. - */ "projects/delete-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ "projects/update-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -85619,6 +93790,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -85628,27 +93802,30 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List project cards - * @description Lists the project cards in a project. - */ "projects/list-cards": { parameters: { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-card"][]; @@ -85659,25 +93836,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ "projects/create-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** * @description The project card's note * @example Update all gems */ note: string | null; - }, - { + } + | { /** * @description The unique identifier of the content associated with the card * @example 42 @@ -85688,14 +93867,15 @@ export interface operations { * @example PullRequest */ content_type: string; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -85705,6 +93885,9 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -85713,6 +93896,9 @@ export interface operations { }; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -85727,12 +93913,15 @@ export interface operations { }; }; }; - /** Move a project column */ "projects/move-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -85748,6 +93937,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -85758,19 +93950,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -85780,25 +93976,32 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ "projects/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Delete Success */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -85811,15 +94014,15 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85852,6 +94055,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -85860,6 +94066,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -85870,33 +94079,39 @@ export interface operations { }; /** @description Not Found if the authenticated user does not have access to the project */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 410: components["responses"]["gone"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ "projects/list-collaborators": { parameters: { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -85909,16 +94124,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ "projects/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85936,7 +94152,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -85945,21 +94164,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ "projects/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -85968,20 +94192,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ "projects/get-permission-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-collaborator-permission"]; }; @@ -85993,25 +94222,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List project columns - * @description Lists the project columns in a project. - */ "projects/list-columns": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-column"][]; @@ -86022,15 +94254,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a project column - * @description Creates a new project column. - */ "projects/create-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86046,6 +94278,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -86056,24 +94291,14 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. - * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.10/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.10/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.10/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.10/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.10/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.10/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.10/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - */ "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -86081,6 +94306,7 @@ export interface operations { "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["rate-limit-overview"]; @@ -86090,22 +94316,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository - * @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. - * - * **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/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -86115,30 +94344,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a repository - * @description Deleting a repository requires admin access. - * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. - * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. - */ "repos/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -86149,16 +94381,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#replace-all-repository-topics) endpoint. - */ "repos/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86171,7 +94404,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -86180,16 +94413,14 @@ export interface operations { * @enum {string} */ visibility?: "public" | "private" | "internal"; - /** - * @description Specify which security and analysis features to enable or disable for the repository. + /** @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.10/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. * - * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { @@ -86263,34 +94494,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -86315,6 +94546,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -86325,31 +94559,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List artifacts for a repository - * @description Lists all artifacts for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-artifacts-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86360,137 +94595,147 @@ export interface operations { }; }; }; - /** - * Get an artifact - * @description Gets a specific artifact for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["artifact"]; }; }; }; }; - /** - * Delete an artifact - * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download an artifact - * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; archive_format: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { Location: components["headers"]["location"]; + [name: string]: unknown; }; - content: never; + content?: never; }; 410: components["responses"]["gone"]; }; }; - /** - * Get GitHub Actions cache usage for a repository - * @description Gets GitHub Actions cache usage for a repository. - * 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. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-by-repository"]; }; }; }; }; - /** - * Get GitHub Actions cache usage policy for a repository - * @description Gets GitHub Actions cache usage policy for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-policy-for-repository"]; }; }; }; }; - /** - * Set GitHub Actions cache usage policy for a repository - * @description Sets GitHub Actions cache usage policy for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-actions-cache-usage-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -86500,36 +94745,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List GitHub Actions caches for a repository - * @description Lists the GitHub Actions caches for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; + /** @description An explicit key or prefix for identifying the cache */ key?: components["parameters"]["actions-cache-key"]; + /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ sort?: components["parameters"]["actions-cache-list-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-list"]; @@ -86537,119 +94791,128 @@ export interface operations { }; }; }; - /** - * Delete GitHub Actions caches for a repository (using a cache key) - * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-key": { parameters: { query: { + /** @description A key for identifying the cache. */ key: components["parameters"]["actions-cache-key-required"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - /** - * Delete a GitHub Actions cache for a repository (using a cache ID) - * @description Deletes a GitHub Actions cache for a repository, using a cache ID. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-id": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the GitHub Actions cache. */ cache_id: components["parameters"]["cache-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a job for a workflow run - * @description Gets a specific job in a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["job"]; }; }; }; }; - /** - * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-job-logs-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Re-run a job from a workflow run - * @description Re-run a job and its dependent jobs in a workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86665,6 +94928,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -86672,22 +94938,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get the customization template for an OIDC subject claim for a repository - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub-repo"]; }; @@ -86696,18 +94965,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set the customization template for an OIDC subject claim for a repository - * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -86722,6 +94990,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -86731,31 +95002,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository organization secrets - * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86766,30 +95036,30 @@ export interface operations { }; }; }; - /** - * List repository organization variables - * @description Lists all organization variables shared with a repository. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86800,42 +95070,42 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions permissions for a repository - * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. - * - * You 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. - */ "actions/get-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-repository-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for a repository - * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. - * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -86848,50 +95118,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-workflow-access-to-repository"]; }; }; }; }; - /** - * Set the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.10/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.10/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -86901,48 +95170,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for a repository - * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * You 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. - */ "actions/get-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for a repository - * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86952,48 +95222,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for a repository - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for a repository - * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.10/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87003,38 +95274,44 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning organization or enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for a repository - * @description Lists all self-hosted runners configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87045,44 +95322,42 @@ export interface operations { }; }; }; - /** - * List runner applications for a repository - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-runner-applications-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for a repository - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the repository. - * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87107,151 +95382,141 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for a repository - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for a repository - * @description Gets a specific self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from a repository - * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for a repository - * @description Lists all labels for a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for a repository - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87267,21 +95532,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for a repository - * @description Adds custom labels to a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87297,89 +95560,89 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for a repository - * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for a repository - * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. - * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-custom-label-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List workflow runs for a repository - * @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/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. - */ "actions/list-workflow-runs-for-repo": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-server@3.10/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-server@3.10/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87390,106 +95653,116 @@ export interface operations { }; }; }; - /** - * Get a workflow run - * @description Gets a specific workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * Delete a workflow run - * @description Deletes a specific workflow run. - * - * Anyone with write access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-reviews-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment-approvals"][]; }; }; }; }; - /** - * List workflow run artifacts - * @description Lists artifacts for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-run-artifacts": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87500,62 +95773,66 @@ export interface operations { }; }; }; - /** - * Get a workflow run attempt - * @description Gets a specific workflow run attempt. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run-attempt": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87567,52 +95844,56 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download workflow run attempt logs - * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-attempt-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Cancel a workflow run - * @description Cancels a workflow run using its `id`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -87620,22 +95901,19 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/review-custom-gates-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87647,38 +95925,41 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List jobs for a workflow run - * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run": { parameters: { query?: { /** @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. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87689,97 +95970,100 @@ export interface operations { }; }; }; - /** - * Download workflow run logs - * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Delete workflow run logs - * @description Deletes all logs for a workflow run. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Get pending deployments for a workflow run - * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pending-deployment"][]; }; }; }; }; - /** - * Review pending deployments for a workflow run - * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. - * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/review-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87787,9 +96071,9 @@ export interface operations { /** * @description The list of environment ids to approve or reject * @example [ - * 161171787, - * 161171795 - * ] + * 161171787, + * 161171795 + * ] */ environment_ids: number[]; /** @@ -87809,25 +96093,28 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"][]; }; }; }; }; - /** - * Re-run a workflow - * @description Re-runs your workflow run using its `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87843,25 +96130,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow-failed-jobs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87877,37 +96167,39 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87918,72 +96210,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -87998,63 +96289,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository variables - * @description Lists all repository variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88065,20 +96364,17 @@ export interface operations { }; }; }; - /** - * Create a repository variable - * @description Creates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88093,75 +96389,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get a repository variable - * @description Gets a specific variable in a repository. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete a repository variable - * @description Deletes a repository variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a repository variable - * @description Updates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -88176,34 +96477,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository workflows - * @description Lists the workflows in a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-repo-workflows": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88214,68 +96518,71 @@ export interface operations { }; }; }; - /** - * Get a workflow - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow"]; }; }; }; }; - /** - * Disable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/disable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * 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`. - * - * You 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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-workflow-dispatch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88292,64 +96599,80 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/enable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow runs for a workflow - * @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/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-runs": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-server@3.10/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-server@3.10/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88360,26 +96683,30 @@ export interface operations { }; }; }; - /** - * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.10/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. - */ "issues/list-assignees": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -88388,67 +96715,75 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user can be assigned - * @description Checks if a user has permission to be assigned to an issue in this repository. - * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - * - * Otherwise a `404` status code is returned. - */ "issues/check-user-can-be-assigned": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Otherwise a `404` status code is returned. */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get all autolinks of a repository - * @description Gets all autolinks that are configured for a repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/list-autolinks": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"][]; }; }; }; }; - /** - * Create an autolink reference for a repository - * @description Users with admin access to the repository can create an autolink. - */ "repos/create-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88471,6 +96806,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["autolink"]; @@ -88479,23 +96815,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an autolink reference of a repository - * @description This returns a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/get-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"]; }; @@ -88503,71 +96843,90 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an autolink reference from a repository - * @description This deletes a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/delete-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.10/articles/configuring-automated-security-fixes)". - */ "repos/check-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if dependabot is enabled */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; /** @description Not Found if dependabot is not enabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List branches */ "repos/list-branches": { parameters: { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-branch"][]; @@ -88576,18 +96935,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get a branch */ "repos/get-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -88596,21 +96964,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get branch protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-protection"]; }; @@ -88618,23 +96992,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update branch protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Protecting a branch requires admin or owner permissions to the repository. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. - */ "repos/update-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -88646,6 +97016,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -88725,6 +97096,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch"]; }; @@ -88734,148 +97108,178 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete branch protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get admin branch protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Set admin branch protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/set-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Delete admin branch protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/delete-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get pull request review protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - /** - * Delete pull request review protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update pull request review protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - */ "repos/update-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88915,6 +97319,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; @@ -88922,25 +97329,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get commit signature protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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/enterprise-server@3.10/articles/signing-commits-with-gpg) in GitHub Help. - * - * **Note**: You must enable branch protection to require signed commits. - */ "repos/get-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -88948,23 +97357,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create commit signature protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/create-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -88972,43 +97385,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete commit signature protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/delete-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get status checks protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-status-checks-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -89016,38 +97439,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove status check protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update status check protection - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/update-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89057,6 +97486,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -89072,6 +97502,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -89080,21 +97513,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all status check contexts - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-all-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -89102,17 +97541,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set status check contexts - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/set-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89125,6 +97566,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -89133,17 +97577,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add status check contexts - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/add-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89156,6 +97602,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -89165,17 +97614,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove status check contexts - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89188,6 +97639,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -89196,25 +97650,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists who has access to this protected branch. - * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. - */ "repos/get-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-restriction-policy"]; }; @@ -89222,44 +97678,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Disables the ability to restrict who can push to this branch. - */ "repos/delete-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get apps with access to the protected branch - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/get-apps-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -89267,19 +97731,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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/enterprise-server@3.10/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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/set-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89292,6 +97756,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -89299,19 +97766,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/add-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89324,6 +97791,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -89331,19 +97801,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/remove-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89356,6 +97826,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -89363,23 +97836,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get teams with access to the protected branch - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. The list includes child teams. - */ "repos/get-teams-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -89387,19 +97864,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - */ "repos/set-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89412,6 +97889,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -89419,19 +97899,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified teams push access for this branch. You can also give push access to child teams. - */ "repos/add-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89444,6 +97924,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -89451,19 +97934,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. - */ "repos/remove-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89476,6 +97959,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -89483,23 +97969,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get users with access to the protected branch - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - */ "repos/get-users-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -89507,23 +97997,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set user 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/set-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89536,6 +98022,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -89543,23 +98032,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add user 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified people push access for this branch. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/add-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89572,6 +98057,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -89579,23 +98067,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a user to push to this branch. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/remove-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89608,6 +98092,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -89615,23 +98102,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Rename a branch - * @description Renames a branch in a repository. - * - * **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/enterprise-server@3.10/github/administering-a-repository/renaming-a-branch)". - * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. - */ "repos/rename-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.10/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -89644,6 +98127,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -89653,20 +98139,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. - * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - */ "checks/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -89692,7 +98175,7 @@ export interface operations { started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ conclusion?: @@ -89766,149 +98249,153 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Get a check run - * @description Gets a single check run using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Update a check run - * @description Updates a check run for a specific commit in a repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The name of the check. For example, "code-coverage". */ - name?: string; - /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; - /** @description A reference for the run on the integrator's system. */ - external_id?: string; - /** - * Format: date-time - * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. - * @enum {string} - */ - status?: - | "queued" - | "in_progress" - | "completed" - | "waiting" - | "requested" - | "pending"; - /** - * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. - * @enum {string} - */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; - /** - * Format: date-time - * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - completed_at?: string; - /** @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. */ - output?: { - /** @description **Required**. */ - title?: string; - /** @description Can contain Markdown. */ - summary: string; - /** @description Can contain Markdown. */ - text?: string; - /** @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/enterprise-server@3.10/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.10/articles/about-status-checks#checks)". */ - annotations?: { - /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; - /** @description The start line of the annotation. Line numbers start at 1. */ - start_line: number; - /** @description The end line of the annotation. */ - end_line: number; - /** @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. */ - start_column?: number; - /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + "application/json": + | { + /** @description The name of the check. For example, "code-coverage". */ + name?: string; + /** @description The URL of the integrator's site that has the full details of the check. */ + details_url?: string; + /** @description A reference for the run on the integrator's system. */ + external_id?: string; /** - * @description The level of the annotation. + * Format: date-time + * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; - /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; - /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; - /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; - /** @description Adds images to the output displayed in the GitHub pull request UI. */ - images?: { - /** @description The alternative text for the image. */ - alt: string; - /** @description The full URL of the image. */ - image_url: string; - /** @description A short image description. */ - caption?: string; - }[]; - }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.10/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - actions?: { - /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; - /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; - /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - } & ( + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; + /** + * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * @enum {string} + */ + conclusion?: + | "action_required" + | "cancelled" + | "failure" + | "neutral" + | "success" + | "skipped" + | "stale" + | "timed_out"; + /** + * Format: date-time + * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** @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. */ + output?: { + /** @description **Required**. */ + title?: string; + /** @description Can contain Markdown. */ + summary: string; + /** @description Can contain Markdown. */ + text?: string; + /** @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/enterprise-server@3.10/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.10/articles/about-status-checks#checks)". */ + annotations?: { + /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** @description The start line of the annotation. Line numbers start at 1. */ + start_line: number; + /** @description The end line of the annotation. */ + end_line: number; + /** @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. */ + start_column?: number; + /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** + * @description The level of the annotation. + * @enum {string} + */ + annotation_level: "notice" | "warning" | "failure"; + /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** @description The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** @description Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + }[]; + /** @description Adds images to the output displayed in the GitHub pull request UI. */ + images?: { + /** @description The alternative text for the image. */ + alt: string; + /** @description The full URL of the image. */ + image_url: string; + /** @description A short image description. */ + caption?: string; + }[]; + }; + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.10/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + actions?: { + /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + }[]; + } | { /** @enum {unknown} */ status?: "completed"; @@ -89918,42 +98405,47 @@ export interface operations { /** @enum {unknown} */ status?: "queued" | "in_progress"; [key: string]: unknown; - } - ); + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-annotations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["check-annotation"][]; @@ -89961,31 +98453,36 @@ export interface operations { }; }; }; - /** - * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.10/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -89993,26 +98490,26 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.10/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#update-repository-preferences-for-check-suites)". - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/create-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90025,29 +98522,35 @@ export interface operations { responses: { /** @description Response when the suite already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.10/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. - */ "checks/set-suites-preferences": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90068,66 +98571,74 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - /** - * Get a check suite - * @description Gets a single check suite using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-suite": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90138,47 +98649,47 @@ export interface operations { }; }; }; - /** - * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List code scanning alerts for a repository - * @description Lists code scanning alerts. - * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; @@ -90187,14 +98698,22 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-items"][]; }; @@ -90205,23 +98724,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning alert - * @description Gets a single code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -90232,18 +98755,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning alert - * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -90257,6 +98781,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -90266,28 +98793,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List instances of a code scanning alert - * @description Lists all instances of the specified code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alert-instances": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-instance"][]; }; @@ -90297,47 +98830,42 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List code scanning analyses for a repository - * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. - * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-recent-analyses": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the analyses 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`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"][]; }; @@ -90347,38 +98875,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning analysis for a repository - * @description Gets a specified code scanning analysis for a repository. - * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. - * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-analysis": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { @@ -90391,89 +98908,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. - * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/delete-analysis": { parameters: { query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ confirm_delete?: string | null; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; @@ -90484,22 +98942,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning default setup configuration - * @description Gets a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup"]; }; @@ -90509,18 +98970,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning default setup configuration - * @description Updates a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90530,12 +98990,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; @@ -90546,47 +99012,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif)." - * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." - * - * You 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: - * - * ``` - * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.10/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." - * - * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/upload-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90597,7 +99033,7 @@ export interface operations { /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. - * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ checkout_uri?: string; @@ -90614,40 +99050,53 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ 413: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ sarif_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; @@ -90655,54 +99104,49 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CODEOWNERS errors - * @description List any syntax errors that are detected in the CODEOWNERS - * file. - * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - */ "repos/codeowners-errors": { parameters: { query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository collaborators - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/list-collaborators": { parameters: { query?: { @@ -90710,19 +99154,27 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["collaborator"][]; @@ -90731,60 +99183,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is a repository collaborator - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/check-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a collaborator */ 404: { - content: never; - }; - }; - }; - /** - * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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-server@3.10/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/enterprise-server@3.10/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: - * - * ``` - * Cannot assign {member} permission of {role name} - * ``` - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **Updating an existing collaborator's permission level** - * - * The 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. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90798,81 +99241,68 @@ export interface operations { }; }; responses: { - /** - * @description Response when: - * - an existing collaborator is added as a collaborator - * - an organization member is added as an individual collaborator - * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator - */ + /** @description Response when: + * - an existing collaborator is added as a collaborator + * - an organization member is added as an individual collaborator + * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository collaborator - * @description Removes a collaborator from a repository. - * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. - * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages - * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. - * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.10/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". - */ "repos/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when collaborator was removed from the repository. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ "repos/get-collaborator-permission-level": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user has admin permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-collaborator-permission"]; }; @@ -90880,33 +99310,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit comments for a repository - * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-commit-comments-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -90914,28 +99341,27 @@ export interface operations { }; }; }; - /** - * Get a commit comment - * @description Gets a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/get-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -90943,41 +99369,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a commit comment */ "repos/delete-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a commit comment - * @description Updates the contents of a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/update-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -90990,6 +99420,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -90997,10 +99430,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). - */ "reactions/list-for-commit-comment": { parameters: { query?: { @@ -91014,20 +99443,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -91036,17 +99474,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. - */ "reactions/create-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91070,12 +99510,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -91083,59 +99529,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.10/rest/commits/comments#get-a-commit-comment). - */ "reactions/delete-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List commits - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/list-commits": { parameters: { query?: { @@ -91147,22 +99567,31 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -91174,23 +99603,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List branches for HEAD commit - * @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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - */ "repos/list-branches-for-head-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-short"][]; }; @@ -91199,34 +99632,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List commit comments - * @description Lists the comments for a specified commit. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-comments-for-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -91234,26 +99665,19 @@ export interface operations { }; }; }; - /** - * Create a commit comment - * @description Create a comment for a commit using its `:commit_sha`. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/create-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; requestBody: { content: { @@ -91275,6 +99699,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"]; @@ -91284,29 +99709,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. - * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. - */ "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -91315,62 +99743,32 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a commit - * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/get-commit": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; @@ -91382,38 +99780,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-ref": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; app_id?: number; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91424,14 +99823,6 @@ export interface operations { }; }; }; - /** - * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-suites-for-ref": { parameters: { query?: { @@ -91440,21 +99831,31 @@ export interface operations { * @example 1 */ app_id?: number; + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91465,32 +99866,32 @@ export interface operations { }; }; }; - /** - * Get the combined status for a specific reference - * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - * - * - * Additionally, a combined `state` is returned. The `state` is one of: - * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` - */ "repos/get-combined-status-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-commit-status"]; }; @@ -91498,29 +99899,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit statuses for a reference - * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - */ "repos/list-commit-statuses-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"][]; @@ -91529,75 +99933,32 @@ export interface operations { 301: components["responses"]["moved_permanently"]; }; }; - /** - * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-server@3.10/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. - * - * **Working with large comparisons** - * - * 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. - * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api)." - * - * **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: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits-with-basehead": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @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`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; @@ -91607,50 +99968,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. - * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. - * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - * - * **Notes**: - * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.10/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. - */ "repos/get-content": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/vnd.github.object": components["schemas"]["content-tree"]; "application/json": @@ -91665,22 +100006,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. - * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. - */ "repos/create-or-update-file-contents": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -91717,12 +100055,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -91732,26 +100076,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a file - * @description Deletes a file in a repository. - * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.10/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - */ "repos/delete-file": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -91782,6 +100119,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -91792,30 +100132,32 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository contributors - * @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. - * - * 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. - */ "repos/list-contributors": { parameters: { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If repository contains content */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["contributor"][]; @@ -91823,26 +100165,41 @@ export interface operations { }; /** @description Response if repository is empty */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List Dependabot alerts for a repository - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-repo": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** * @deprecated @@ -91854,19 +100211,35 @@ export interface operations { * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"][]; }; @@ -91878,21 +100251,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a Dependabot alert - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -91902,26 +100284,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The state of the Dependabot alert. - * A `dismissed_reason` must be provided when setting the state to `dismissed`. + * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ state: "dismissed" | "open"; @@ -91943,6 +100328,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -91954,29 +100342,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91987,67 +100376,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. - */ "dependabot/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -92062,58 +100455,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a diff of the dependencies between commits - * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. - */ "dependency-graph/diff-range": { parameters: { query?: { + /** @description The full path, relative to the repository root, of the dependency manifest file. */ name?: components["parameters"]["manifest-path"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-diff"]; @@ -92123,22 +100529,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Export a software bill of materials (SBOM) for a repository. - * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. - */ "dependency-graph/export-sbom": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; @@ -92148,20 +100557,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. - * - * The authenticated user must have access to the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependency-graph/create-repository-snapshot": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92171,6 +100577,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description ID of the created snapshot. */ @@ -92186,10 +100595,6 @@ export interface operations { }; }; }; - /** - * List deployments - * @description Simple filtering of deployments is available via query parameters: - */ "repos/list-deployments": { parameters: { query?: { @@ -92200,20 +100605,28 @@ export interface operations { /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment"][]; @@ -92221,63 +100634,17 @@ export interface operations { }; }; }; - /** - * Create a deployment - * @description Deployments offer a few configurable parameters with certain defaults. - * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them - * before we merge a pull request. - * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. - * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. - * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. - * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. - * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. - * - * Merged branch response: - * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts - * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. - * - * Merge conflict response: - * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * Failed commit status checks: - * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92296,14 +100663,11 @@ export interface operations { auto_merge?: boolean; /** @description The [status](https://docs.github.com/enterprise-server@3.10/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; - payload?: OneOf< - [ - { + payload?: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production @@ -92327,12 +100691,18 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -92341,23 +100711,35 @@ export interface operations { }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** Get a deployment */ "repos/get-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; @@ -92365,57 +100747,59 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * To set a deployment as inactive, you must: - * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. - * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.10/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.10/rest/deployments/statuses#create-a-deployment-status)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/delete-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List deployment statuses - * @description Users with pull access can view deployment statuses for a deployment: - */ "repos/list-deployment-statuses": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"][]; @@ -92424,19 +100808,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a deployment status - * @description Users with `push` access can create deployment statuses for a given deployment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -92486,6 +100870,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"]; @@ -92494,22 +100879,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a deployment status - * @description Users with pull access can view a deployment status for a deployment: - */ "repos/get-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; status_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-status"]; }; @@ -92517,22 +100908,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#repository_dispatch)." - * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-dispatch-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92549,34 +100935,39 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List environments - * @description Lists the environments for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -92590,48 +100981,46 @@ export interface operations { }; }; }; - /** - * Get an environment - * @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)." - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; }; }; - /** - * Create or update an environment - * @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)." - * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-or-update-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92655,60 +101044,75 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Delete an environment - * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-an-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List deployment branch policies - * @description Lists the deployment branch policies for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-deployment-branch-policies": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -92722,19 +101126,19 @@ export interface operations { }; }; }; - /** - * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -92744,60 +101148,73 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ 303: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -92807,53 +101224,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-deployment-protection-rules": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of deployment protection rules */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -92867,23 +101294,19 @@ export interface operations { }; }; }; - /** - * Create a custom deployment protection rule on an environment - * @description Enable a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; requestBody: { content: { @@ -92896,37 +101319,41 @@ export interface operations { responses: { /** @description The enabled custom deployment protection rule */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. - * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app)". - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-custom-deployment-rule-integrations": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A list of custom deployment rule integrations available for this environment. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -92940,82 +101367,88 @@ export interface operations { }; }; }; - /** - * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.10/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.10/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-custom-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * Disable a custom protection rule for an environment - * @description Disables a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/disable-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -93026,75 +101459,77 @@ export interface operations { }; }; }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -93109,65 +101544,75 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -93178,21 +101623,19 @@ export interface operations { }; }; }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -93207,78 +101650,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -93293,53 +101744,69 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - */ "activity/list-repo-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List forks */ "repos/list-forks": { parameters: { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -93348,20 +101815,17 @@ export interface operations { 400: components["responses"]["bad_request"]; }; }; - /** - * Create a fork - * @description Create a fork for the authenticated user. - * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. - */ "repos/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93378,6 +101842,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -93388,13 +101855,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Create a blob */ "git/create-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93415,6 +101886,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-blob"]; @@ -93426,28 +101898,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a blob - * @description The `content` in the response will always be Base64 encoded. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. - * - * **Note** This endpoint supports blobs up to 100 megabytes in size. - */ "git/get-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; file_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["blob"]; }; @@ -93458,45 +101928,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a commit - * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93542,6 +101984,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-commit"]; @@ -93552,52 +101995,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a commit object - * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-commit"]; }; @@ -93606,29 +102024,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List matching references - * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - */ "git/list-matching-refs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"][]; @@ -93637,23 +102056,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a reference - * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - */ "git/get-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -93662,16 +102088,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a reference - * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. - */ "git/create-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93689,6 +102116,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"]; @@ -93698,38 +102126,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a reference - * @description Deletes the provided reference. - */ "git/delete-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a reference - * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - */ "git/update-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; requestBody: { content: { @@ -93747,6 +102189,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -93755,45 +102200,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.10/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93830,6 +102247,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tag"]; @@ -93839,48 +102257,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tag - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; tag_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tag"]; }; @@ -93889,20 +102285,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a tree - * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.10/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.10/rest/git/refs#update-a-reference)." - * - * Returns an error if you try to delete a file that does not exist. - */ "git/create-tree": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93921,23 +102314,18 @@ export interface operations { * @enum {string} */ type?: "blob" | "tree" | "commit"; - /** - * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + /** @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ sha?: string | null; - /** - * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + /** @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ content?: string; }[]; - /** - * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - */ + /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + * */ base_tree?: string; }; }; @@ -93948,6 +102336,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tree"]; @@ -93959,31 +102348,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tree - * @description Returns a single tree using the SHA1 value or ref name for that tree. - * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. - */ "git/get-tree": { parameters: { query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ recursive?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tree"]; }; @@ -93993,26 +102381,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository webhooks - * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. - */ "repos/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"][]; @@ -94021,17 +102413,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository webhook - * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. - */ "repos/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94048,8 +102440,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -94066,6 +102458,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"]; @@ -94076,21 +102469,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." - */ "repos/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -94098,34 +102497,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ "repos/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." - */ "repos/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94134,8 +102544,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ @@ -94153,6 +102563,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -94161,42 +102574,46 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. - */ "repos/get-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. - */ "repos/update-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94211,32 +102628,42 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for a repository webhook - * @description Returns a list of webhook deliveries for a webhook configured in a repository. - */ "repos/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -94245,22 +102672,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for a repository webhook - * @description Returns a delivery for a webhook configured in a repository. - */ "repos/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -94269,83 +102702,99 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for a repository webhook - * @description Redeliver a webhook delivery for a webhook configured in a repository. - */ "repos/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the hook. - */ "repos/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Test the push repository webhook - * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - */ "repos/test-push-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository installation for the authenticated app - * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-repo-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -94354,26 +102803,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repository invitations - * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. - */ "repos/list-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -94381,30 +102834,44 @@ export interface operations { }; }; }; - /** Delete a repository invitation */ "repos/delete-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a repository invitation */ "repos/update-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94420,28 +102887,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - /** - * List repository issues - * @description List issues in a repository. Only open issues will be listed. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-repo": { parameters: { query?: { @@ -94455,24 +102909,35 @@ export interface operations { creator?: string; /** @description A user that's mentioned in the issue. */ mentioned?: string; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -94483,26 +102948,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.10/articles/disabling-issues/), the API returns a `410 Gone` status. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94513,19 +102969,17 @@ export interface operations { body?: string; /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ assignee?: string | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; }; @@ -94537,6 +102991,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"]; @@ -94550,39 +103005,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List issue comments for a repository - * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. - * - * By default, issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments-for-repo": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -94592,28 +103044,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue comment - * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -94621,43 +103072,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an issue comment - * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - */ "issues/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an issue comment - * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94670,6 +103122,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -94677,10 +103132,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). - */ "reactions/list-for-issue-comment": { parameters: { query?: { @@ -94694,20 +103145,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -94716,17 +103176,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. - */ "reactions/create-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94750,12 +103212,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -94763,48 +103231,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#get-an-issue-comment). - */ "reactions/delete-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List issue events for a repository - * @description Lists events for a repository. - */ "issues/list-events-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event"][]; @@ -94813,21 +103290,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue event - * @description Gets a single event by the event id. - */ "issues/get-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; event_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-event"]; }; @@ -94837,38 +103319,27 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.10/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-server@3.10/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 - * 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/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -94879,30 +103350,25 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update an issue - * @description Issue owners and users with push access can edit an issue. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** @description The title of the issue. */ - title?: string | number | null; + title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; /** @description Username to assign to this issue. **This field is deprecated.** */ @@ -94918,19 +103384,17 @@ export interface operations { * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; }; @@ -94939,6 +103403,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -94951,17 +103418,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Add assignees to an issue - * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - */ "issues/add-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94974,23 +103443,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Remove assignees from an issue - * @description Removes one or more assignees from an issue. - */ "issues/remove-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -95003,73 +103477,78 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Check if a user can be assigned to a issue - * @description 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. - */ "issues/check-user-can-be-assigned-to-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List issue comments - * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * Issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -95079,29 +103558,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create an issue comment - * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -95117,6 +103586,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"]; @@ -95128,27 +103598,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List issue events - * @description Lists all events for an issue. - */ "issues/list-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event-for-issue"][]; @@ -95157,27 +103632,32 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * List labels for an issue - * @description Lists all labels for an issue. - */ "issues/list-labels-on-issue": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -95188,38 +103668,40 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Set labels for an issue - * @description Removes any previous labels and sets the new labels for an issue. - */ "issues/set-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.10/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -95230,38 +103712,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. - */ "issues/add-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.10/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -95272,44 +103756,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all labels from an issue - * @description Removes all labels from an issue. - */ "issues/remove-all-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 301: components["responses"]["moved_permanently"]; 404: components["responses"]["not_found"]; 410: components["responses"]["gone"]; }; }; - /** - * Remove a label from an issue - * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. - */ "issues/remove-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -95319,29 +103815,29 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Lock an issue - * @description Users with push access can lock an issue or pull request's conversation. - * - * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "issues/lock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` * @enum {string} */ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; @@ -95351,7 +103847,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -95359,31 +103858,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unlock an issue - * @description Users with push access can unlock an issue's conversation. - */ "issues/unlock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). - */ "reactions/list-for-issue": { parameters: { query?: { @@ -95397,20 +103898,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -95420,17 +103930,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. - */ "reactions/create-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -95454,12 +103966,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -95467,49 +103985,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.10/rest/issues/issues#get-an-issue). - */ "reactions/delete-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List timeline events for an issue - * @description List all timeline events for an issue. - */ "issues/list-events-for-timeline": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["timeline-issue-events"][]; @@ -95519,23 +104047,30 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** List deploy keys */ "repos/list-deploy-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"][]; @@ -95543,16 +104078,17 @@ export interface operations { }; }; }; - /** - * Create a deploy key - * @description You can create a read-only deploy key. - */ "repos/create-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95561,11 +104097,9 @@ export interface operations { title?: string; /** @description The contents of the key. */ key: string; - /** - * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + /** @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.10/articles/permission-levels-for-a-user-account-repository/)." - */ + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.10/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.10/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; }; @@ -95576,6 +104110,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"]; @@ -95584,18 +104119,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get a deploy key */ "repos/get-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deploy-key"]; }; @@ -95603,45 +104147,55 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a deploy key - * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. - */ "repos/delete-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a repository - * @description Lists all labels for a repository. - */ "issues/list-labels-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -95650,16 +104204,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a label - * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). - */ "issues/create-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95679,6 +104234,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"]; @@ -95688,21 +104244,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a label - * @description Gets a label using the given name. - */ "issues/get-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; @@ -95710,36 +104271,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a label - * @description Deletes a label using the given label name. - */ "issues/delete-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a label - * @description Updates a label using the given label name. - */ "issues/update-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; requestBody?: { content: { @@ -95756,98 +104323,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; }; }; }; - /** - * List repository languages - * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. - */ "repos/list-languages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["language"]; }; }; }; }; - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/enable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; - /** - * @description We will return a 403 with one of the following messages: + /** @description We will return a 403 with one of the following messages: * - * - Git LFS support not enabled because Git LFS is globally disabled. - * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - * - Git LFS support not enabled because Git LFS is disabled for . - */ + * - Git LFS support not enabled because Git LFS is globally disabled. + * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + * - Git LFS support not enabled because Git LFS is disabled for . */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/disable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the license for a repository - * @description This method returns the contents of the repository's license file, if one is detected. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "licenses/get-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-content"]; }; @@ -95855,16 +104434,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Sync a fork branch with the upstream repository - * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. - */ "repos/merge-upstream": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95877,27 +104457,40 @@ export interface operations { responses: { /** @description The branch has been successfully synced with the upstream repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The branch could not be synced for some other reason */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Merge a branch */ "repos/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95914,30 +104507,38 @@ export interface operations { responses: { /** @description Successful Response (The resulting merge commit) */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when there is a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * List milestones - * @description Lists milestones for a repository. - */ "issues/list-milestones": { parameters: { query?: { @@ -95947,19 +104548,27 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"][]; @@ -95968,16 +104577,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a milestone - * @description Creates a milestone. - */ "issues/create-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96006,6 +104616,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"]; @@ -96015,21 +104626,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a milestone - * @description Gets a milestone using the given milestone number. - */ "issues/get-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; @@ -96037,34 +104654,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a milestone - * @description Deletes a milestone using the given milestone number. - */ "issues/delete-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** Update a milestone */ "issues/update-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96090,33 +104718,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; }; }; }; - /** - * List labels for issues in a milestone - * @description Lists labels for issues in a milestone. - */ "issues/list-labels-for-milestone": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -96124,30 +104760,38 @@ export interface operations { }; }; }; - /** - * List repository notifications for the authenticated user - * @description Lists all notifications for the current user in the specified repository. - */ "activity/list-repo-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -96155,16 +104799,17 @@ export interface operations { }; }; }; - /** - * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-repo-notifications-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96180,6 +104825,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -96189,26 +104837,32 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a GitHub Enterprise Server Pages site - * @description Gets information about a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -96216,97 +104870,109 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update information about a GitHub Enterprise Server Pages site - * @description Updates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-information-about-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.10/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @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. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: - | ("gh-pages" | "master" | "master /docs") - | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - }; + "application/json": + | { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.10/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @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. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: + | ("gh-pages" | "master" | "master /docs") + | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + } + | unknown + | unknown + | unknown + | unknown + | unknown; }; }; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["bad_request"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a GitHub Enterprise Server Pages site - * @description Configures a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } | null; + "application/json": + | ( + | { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } + | unknown + | unknown + ) + | null; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -96315,53 +104981,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a GitHub Enterprise Server Pages site - * @description Deletes a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List GitHub Enterprise Server Pages builds - * @description Lists builts of a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/list-pages-builds": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["page-build"][]; @@ -96369,85 +105038,93 @@ export interface operations { }; }; }; - /** - * Request a GitHub Enterprise Server Pages build - * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - */ "repos/request-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - /** - * Get latest Pages build - * @description Gets information about the single most recent build of a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-latest-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Get GitHub Enterprise Server Pages build - * @description Gets information about a GitHub Enterprise Server Pages build. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; build_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Create a GitHub Pages deployment - * @description Create a GitHub Pages deployment for a repository. - * - * The authenticated user must have write permission to the repository. - */ "repos/create-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96472,6 +105149,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-deployment"]; }; @@ -96481,84 +105161,106 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pre-receive hooks for a repository - * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. - */ "enterprise-admin/list-pre-receive-hooks-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "name"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"][]; }; }; }; }; - /** Get a pre-receive hook for a repository */ "enterprise-admin/get-pre-receive-hook-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * Remove pre-receive hook enforcement for a repository - * @description Deletes any overridden enforcement on this repository for the specified hook. - * - * Responds with effective values inherited from owner and/or global level. - */ "enterprise-admin/remove-pre-receive-hook-enforcement-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Responds with effective values inherited from owner and/or global level. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * Update pre-receive hook enforcement for a repository - * @description For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` - */ "enterprise-admin/update-pre-receive-hook-enforcement-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96574,34 +105276,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-repo": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -96614,16 +105323,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96638,6 +105348,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -96649,23 +105362,6 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List pull requests - * @description Lists pull requests in a specified repository. - * - * 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/enterprise-server@3.10/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list": { parameters: { query?: { @@ -96679,19 +105375,27 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -96701,27 +105405,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96759,6 +105453,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request"]; @@ -96768,38 +105463,35 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments-for-repo": { parameters: { query?: { sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -96807,28 +105499,27 @@ export interface operations { }; }; }; - /** - * Get a review comment for a pull request - * @description Provides details for a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; @@ -96836,44 +105527,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a review comment for a pull request - * @description Deletes a review comment. - */ "pulls/delete-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a review comment for a pull request - * @description Edits the content of a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96886,16 +105578,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - /** - * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { @@ -96909,20 +105600,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -96931,17 +105631,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. - */ "reactions/create-for-pull-request-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96965,12 +105667,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -96978,65 +105686,54 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/delete-for-pull-request-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Get a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists details of a pull request by providing its number. - * - * When you get, [create](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.10/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "pulls/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -97048,26 +105745,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97091,6 +105781,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -97099,39 +105792,38 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments on a pull request - * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -97139,31 +105831,19 @@ export interface operations { }; }; }; - /** - * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.10/rest/issues/comments#create-an-issue-comment)." - * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -97212,6 +105892,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -97221,28 +105902,21 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a reply for a review comment - * @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. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-reply-for-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97258,6 +105932,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -97266,36 +105941,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.10/rest/commits/commits#list-commits) - * endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -97303,37 +105974,32 @@ export interface operations { }; }; }; - /** - * List pull requests files - * @description Lists the files in a specified pull request. - * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-files": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["diff-entry"][]; @@ -97344,41 +106010,51 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Check if a pull request has been merged - * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. - */ "pulls/check-if-merged": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if pull request has been merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if pull request has not been merged */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Merge a pull request - * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - */ "pulls/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97400,6 +106076,9 @@ export interface operations { responses: { /** @description if merge was successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-merge-result"]; }; @@ -97408,6 +106087,9 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ 405: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -97417,6 +106099,9 @@ export interface operations { }; /** @description Conflict if sha was provided and pull request head did not match */ 409: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -97427,23 +106112,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. - */ "pulls/list-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-request"]; @@ -97451,17 +106140,19 @@ export interface operations { }; }; }; - /** - * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - */ "pulls/request-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97476,6 +106167,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -97483,21 +106177,26 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove requested reviewers from a pull request - * @description Removes review requests from a pull request for a given set of users and/or teams. - */ "pulls/remove-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -97512,6 +106211,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -97519,34 +106221,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reviews for a pull request - * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-reviews": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The list of reviews returns in chronological order. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review"][]; @@ -97554,32 +106254,19 @@ export interface operations { }; }; }; - /** - * Create a review for a pull request - * @description Creates a review on a specified pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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/enterprise-server@3.10/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/pulls#get-a-pull-request) endpoint. - * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97616,6 +106303,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -97624,29 +106314,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a review for a pull request - * @description Retrieves a pull request review by its ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -97654,25 +106344,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a review for a pull request - * @description Updates the contents of a specified review summary comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97685,6 +106371,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -97692,29 +106381,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete a pending review for a pull request - * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/delete-pending-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -97723,35 +106412,34 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List comments for a pull request review - * @description Lists comments for a specific pull request review. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-comments-for-review": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["review-comment"][]; @@ -97760,29 +106448,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Dismiss a review for a pull request - * @description Dismisses a specified review on a pull request. - * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.10/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/dismiss-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97800,6 +106480,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -97808,25 +106491,21 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.10/rest/pulls/reviews#create-a-review-for-a-pull-request)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/submit-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97844,6 +106523,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -97853,17 +106535,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Update a pull request branch - * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - */ "pulls/update-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97876,6 +106560,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -97887,29 +106574,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README - * @description Gets the preferred README for a repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -97918,31 +106604,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README for a directory - * @description Gets the README from a repository directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme-in-directory": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ dir: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -97951,28 +106636,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#list-repository-tags). - * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - */ "repos/list-releases": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"][]; @@ -97981,18 +106668,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a release - * @description Users with push access to the repository can create a release. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - */ "repos/create-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98035,6 +106721,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"]; @@ -98043,21 +106730,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. - */ "repos/get-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; @@ -98066,33 +106759,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a release asset */ "repos/delete-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release asset - * @description Users with push access to the repository can edit a release asset. - */ "repos/update-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98109,22 +106813,26 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; }; }; - /** - * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. - */ "repos/generate-release-notes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98143,6 +106851,9 @@ export interface operations { responses: { /** @description Name and body of generated release notes */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-notes-content"]; }; @@ -98150,44 +106861,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the latest release - * @description View the latest published full release for the repository. - * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - */ "repos/get-latest-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** - * Get a release by tag name - * @description Get a published release with the specified tag. - */ "repos/get-release-by-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description tag parameter */ tag: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; @@ -98195,65 +106914,78 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a release - * @description Gets a public release with the specified release ID. - * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - */ "repos/get-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a release - * @description Users with push access to the repository can delete a release. - */ "repos/delete-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release - * @description Users with push access to the repository can edit a release. - */ "repos/update-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98282,30 +107014,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** List release assets */ "repos/list-release-assets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release-asset"][]; @@ -98313,39 +107056,22 @@ export interface operations { }; }; }; - /** - * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#create-a-release) to upload a release asset. - * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - * - * `application/zip` - * - * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. - * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. - * - * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.10/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. - */ "repos/upload-release-asset": { parameters: { query: { name: string; label?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98355,39 +107081,50 @@ export interface operations { responses: { /** @description Response for successful upload */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). - */ "reactions/list-for-release": { parameters: { query?: { /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -98396,17 +107133,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. - */ "reactions/create-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -98422,12 +107161,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -98435,48 +107180,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.10/rest/releases/releases#get-a-release). - */ "reactions/delete-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository cache replication status - * @description Lists the status of each repository cache replica. - */ "repos/list-cache-info": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status information for cache replicas */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -98495,65 +107249,81 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List secret scanning alerts for a repository - * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.10/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a secret scanning alert - * @description Gets a single secret scanning alert detected in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; @@ -98561,26 +107331,27 @@ export interface operations { 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a secret scanning alert - * @description Updates the status of a secret scanning alert in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -98594,50 +107365,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description State does not match the resolution or resolution comment */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List locations for a secret scanning alert - * @description Lists all locations for a given secret scanning alert for an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-locations-for-alert": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["secret-scanning-location"][]; @@ -98645,35 +107429,38 @@ export interface operations { }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List stargazers - * @description Lists the people that have starred the repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-stargazers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -98684,20 +107471,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the weekly commit activity - * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - */ "repos/get-code-frequency-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -98706,20 +107498,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the last year of commit activity - * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. - */ "repos/get-commit-activity-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-activity"][]; }; @@ -98728,26 +107525,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get all contributor commit activity - * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits - */ "repos/get-contributors-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["contributor-activity"][]; }; @@ -98756,24 +107552,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the weekly commit count - * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - * - * The array order is oldest week (index 0) to most recent week. - * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. - */ "repos/get-participation-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The array order is oldest week (index 0) to most recent week. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["participation-stats"]; }; @@ -98781,26 +107578,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the hourly commit count for each day - * @description Each array contains the day number, hour number, and number of commits: - * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits - * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - */ "repos/get-punch-card-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -98808,19 +107604,18 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Create a commit status - * @description Users with push access in a repository can create commit statuses for a given SHA. - * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - */ "repos/create-commit-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; sha: string; }; + cookie?: never; }; requestBody: { content: { @@ -98830,11 +107625,9 @@ export interface operations { * @enum {string} */ state: "error" | "failure" | "pending" | "success"; - /** - * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. - * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: - * `http://ci.example.com/user/repo/build/sha` - */ + /** @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; /** @description A short description of the status. */ description?: string | null; @@ -98852,6 +107645,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"]; @@ -98859,26 +107653,30 @@ export interface operations { }; }; }; - /** - * List watchers - * @description Lists the people watching the specified repository. - */ "activity/list-watchers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -98886,20 +107684,25 @@ export interface operations { }; }; }; - /** - * Get a repository subscription - * @description Gets information about whether the authenticated user is subscribed to the repository. - */ "activity/get-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if you subscribe to the repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; @@ -98907,20 +107710,24 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#delete-a-repository-subscription) completely. - */ "activity/set-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98935,47 +107742,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - /** - * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.10/rest/activity/watching#set-a-repository-subscription). - */ "activity/delete-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List repository tags */ "repos/list-tags": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["tag"][]; @@ -98983,22 +107805,25 @@ export interface operations { }; }; }; - /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ "repos/list-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"][]; }; @@ -99007,17 +107832,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/create-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99030,6 +107855,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"]; }; @@ -99038,78 +107866,83 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/delete-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the tag protection. */ tag_protection_id: components["parameters"]["tag-protection-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Download a repository archive (tar) - * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. - */ "repos/download-tarball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * List repository teams - * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. - * - * For a public repository, a team is listed only if that team added the public repository explicitly. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. - */ "repos/list-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -99118,21 +107951,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get all repository topics */ "repos/get-all-topics": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -99140,13 +107982,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Replace all repository topics */ "repos/replace-all-topics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99159,6 +108005,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -99167,16 +108016,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.10/articles/about-repository-transfers/). - */ "repos/transfer": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99193,113 +108043,128 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - /** - * Check if vulnerability alerts are enabled for a repository - * @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/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/check-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if repository is enabled with vulnerability alerts */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not enabled with vulnerability alerts */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable vulnerability alerts - * @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/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/enable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable vulnerability alerts - * @description Disables dependency alerts 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/enterprise-server@3.10/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/disable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download a repository archive (zip) - * @description 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 - * 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. - */ "repos/download-zipball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.10/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-using-template": { parameters: { + query?: never; + header?: never; path: { /** @description The account owner of the template repository. The name is not case sensitive. */ template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ template_repo: string; }; + cookie?: never; }; requestBody: { content: { @@ -99329,6 +108194,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -99336,28 +108202,26 @@ export interface operations { }; }; }; - /** - * List public repositories - * @description Lists all public repositories in the order that they were created. - * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. - */ "repos/list-public": { parameters: { query?: { + /** @description A repository ID. Only return repositories with an ID greater than this ID. */ since?: components["parameters"]["since-repo"]; /** @description Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise. */ visibility?: "all" | "public"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -99367,30 +108231,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Lists provisioned SCIM groups in an enterprise. - * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. - */ "enterprise-admin/list-provisioned-groups-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either groups were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-list"]; }; @@ -99402,19 +108268,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Creates a SCIM group for an enterprise. - * - * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. - */ "enterprise-admin/provision-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -99424,6 +108286,9 @@ export interface operations { responses: { /** @description Group has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -99436,25 +108301,28 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Gets information about a SCIM group. - */ "enterprise-admin/get-provisioning-information-for-enterprise-group": { parameters: { query?: { + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; }; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a group was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -99467,20 +108335,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Replaces an existing provisioned group’s information. - * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. - */ "enterprise-admin/set-information-for-provisioned-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -99490,6 +108355,9 @@ export interface operations { responses: { /** @description Group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -99503,23 +108371,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Deletes a SCIM group from an enterprise. - */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Group was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -99529,22 +108400,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Update a provisioned group’s individual attributes. - * - * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. - * - * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. - */ "enterprise-admin/update-attribute-for-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -99554,13 +108420,19 @@ export interface operations { responses: { /** @description Success, group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; }; /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -99571,29 +108443,30 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Lists provisioned SCIM enterprise members. - * - * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. - */ "enterprise-admin/list-provisioned-identities-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either users were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-list"]; }; @@ -99605,21 +108478,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Creates an external identity for a new SCIM enterprise user. - * - * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. - * - * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. - */ "enterprise-admin/provision-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -99629,6 +108496,9 @@ export interface operations { responses: { /** @description User has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -99641,22 +108511,25 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Gets information about a SCIM user. - */ "enterprise-admin/get-provisioning-information-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a user was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -99669,22 +108542,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Replaces an existing provisioned user's information. - * - * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -99694,6 +108562,9 @@ export interface operations { responses: { /** @description User was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -99707,23 +108578,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. - */ "enterprise-admin/delete-user-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description User was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -99733,34 +108607,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Update a provisioned user's individual attributes. - * - * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). - * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` - */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -99770,6 +108627,9 @@ export interface operations { responses: { /** @description Success, user was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -99783,27 +108643,6 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). - * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: - * - * `q=addClass+in:file+language:js+repo:jquery/jquery` - * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. - * - * Considerations for code search: - * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: - * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - */ "search/code": { parameters: { query: { @@ -99813,13 +108652,22 @@ export interface operations { sort?: "indexed"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -99834,17 +108682,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). - * - * 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/enterprise-server@3.10/rest/search/search#text-match-metadata). - * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - * - * `q=repo:octocat/Spoon-Knife+css` - */ "search/commits": { parameters: { query: { @@ -99852,14 +108689,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -99871,21 +108718,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). - * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.10/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." - */ "search/issues-and-pull-requests": { parameters: { query: { @@ -99904,14 +108736,24 @@ export interface operations { | "interactions" | "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -99926,18 +108768,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). - * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - * - * `q=bug+defect+enhancement&repository_id=64778136` - * - * The labels that best match the query appear first in the search results. - */ "search/labels": { parameters: { query: { @@ -99947,14 +108777,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -99969,18 +108809,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). - * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: - * - * `q=tetris+language:assembly&sort=stars&order=desc` - * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - */ "search/repos": { parameters: { query: { @@ -99988,14 +108816,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -100009,30 +108847,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.10/articles/searching-topics/)" for a detailed list of qualifiers. - * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). - * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: - * - * `q=ruby+is:featured` - * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - */ "search/topics": { parameters: { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.10/rest/search/search#constructing-a-search-query). */ q: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -100044,20 +108879,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.10/rest/search/search#text-match-metadata). - * - * For example, if you're looking for a list of popular users, you might try this query: - * - * `q=tom+repos:%3E42+followers:%3E1000` - * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.10/graphql/reference/queries#search)." - */ "search/users": { parameters: { query: { @@ -100065,14 +108886,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.10/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -100086,84 +108917,100 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get the configuration status - * @description This endpoint allows you to check the status of the most recent configuration process: - * - * Note that you may need to wait several seconds after you start a process before you can check its status. - * - * The different statuses are: - * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | - */ "enterprise-admin/get-configuration-status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["configuration-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Start a configuration process - * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: - */ "enterprise-admin/start-configuration-process": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the maintenance status - * @description Check your installation's maintenance status: - */ "enterprise-admin/get-maintenance-status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["maintenance-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/enable-or-disable-maintenance-mode": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { - /** - * @description A JSON string with the attributes `enabled` and `when`. + /** @description A JSON string with the attributes `enabled` and `when`. * - * The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. + * The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). */ maintenance: string; }; }; @@ -100171,46 +109018,56 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["maintenance-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#set-settings). - * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. - */ "enterprise-admin/get-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-settings"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#get-settings). - * - * **Notes:** - * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.10/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." - */ "enterprise-admin/set-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -100222,34 +109079,54 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Get all authorized SSH keys */ "enterprise-admin/get-all-authorized-ssh-keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/add-authorized-ssh-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -100261,21 +109138,29 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/remove-authorized-ssh-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -100287,30 +109172,29 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; - }; - }; - }; - /** - * Create a GitHub license - * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. - * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.10/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. - * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: - * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "enterprise-admin/create-enterprise-server-license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "multipart/form-data": { @@ -100326,21 +109210,27 @@ export interface operations { responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Upgrade a license - * @description This API upgrades your license and also triggers the configuration process. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ "enterprise-admin/upgrade-license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "multipart/form-data": { @@ -100352,28 +109242,37 @@ export interface operations { responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#get-a-team-by-name) endpoint. - */ "teams/get-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -100381,44 +109280,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#delete-a-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - */ "teams/delete-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#update-a-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - */ "teams/update-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -100429,18 +109322,18 @@ export interface operations { description?: string; /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -100460,12 +109353,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -100475,31 +109374,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -100507,22 +109405,15 @@ export interface operations { }; }; }; - /** - * Create a discussion (Legacy) - * @deprecated - * @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/enterprise-server@3.10/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -100542,75 +109433,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -100625,38 +109515,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -100664,23 +109557,17 @@ export interface operations { }; }; }; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @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/enterprise-server@3.10/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.10/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.10/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.10/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -100693,78 +109580,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -100777,21 +109666,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { @@ -100805,20 +109688,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -100826,24 +109718,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.10/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -100867,21 +109754,15 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { @@ -100895,19 +109776,27 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -100915,23 +109804,17 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.10/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.10/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -100955,36 +109838,39 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List team members (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.10/rest/teams/members#list-team-members) endpoint. - * - * Team members will include the members of child teams. - */ "teams/list-members-legacy": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -100993,126 +109879,123 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get team member (Legacy) - * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/get-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if user is not a member */ 404: { - content: never; - }; - }; - }; - /** - * Add team member (Legacy) - * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ 422: { - content: never; - }; - }; - }; - /** - * Remove team member (Legacy) - * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/remove-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team synchronization is setup */ 404: { - content: never; - }; - }; - }; - /** - * Get team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#get-team-membership-for-a-user) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#create-a-team). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/get-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; @@ -101120,27 +110003,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add or update team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If 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. - */ "teams/add-or-update-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -101157,72 +110030,82 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.10/rest/teams/members#remove-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.10/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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.10/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ "teams/remove-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ "teams/list-projects-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -101231,46 +110114,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - */ "teams/check-permissions-for-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - */ "teams/add-or-update-project-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -101286,10 +110172,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -101301,49 +110193,53 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - */ "teams/remove-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List team repositories (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-team-repositories) endpoint. - */ "teams/list-repos-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -101352,56 +110248,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a repository (Legacy) - * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.10/rest/overview/media-types/) via the `Accept` header: - */ "teams/check-permissions-for-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with extra repository information */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions (Legacy) - * @deprecated - * @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/enterprise-server@3.10/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. - * - * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "teams/add-or-update-repo-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -101417,54 +110317,62 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#remove-a-repository-from-a-team) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - */ "teams/remove-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.10/rest/teams/teams#list-child-teams) endpoint. - */ "teams/list-child-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -101475,14 +110383,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. - */ "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -101494,11 +110408,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Update the authenticated user - * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. - */ "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -101542,6 +110458,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["private-user"]; }; @@ -101553,41 +110472,45 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get list of conflicting packages during Docker migration for authenticated-user - * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; }; }; }; - /** - * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible - * to the public. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -101599,11 +110522,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -101618,6 +110543,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["email"][]; }; @@ -101629,11 +110557,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -101645,7 +110575,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101654,22 +110587,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List followers of the authenticated user - * @description Lists the people following the authenticated user. - */ "users/list-followers-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -101680,22 +110616,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List the people the authenticated user follows - * @description Lists the people who the authenticated user follows. - */ "users/list-followed-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -101706,45 +110645,57 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Check if a person is followed by the authenticated user */ "users/check-person-is-followed-by-authenticated": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the person is followed by the authenticated user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/follow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101752,20 +110703,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unfollow a user - * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/unfollow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101773,24 +110728,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -101802,13 +110758,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -101822,6 +110778,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -101833,21 +110792,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/get-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -101858,22 +110819,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. - */ "users/delete-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101882,26 +110845,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List app installations accessible to the user access token - * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You can find the permissions for the installation under the `permissions` key. - */ "apps/list-installations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -101915,29 +110877,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories accessible to the user access token - * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * The access the user has to each repository is included in the hash under the `permissions` key. - */ "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -101952,68 +110913,65 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add a repository to an app installation - * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */ 422: { - content: never; - }; - }; - }; - /** - * List user account issues assigned to the authenticated user - * @description 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 - * 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/enterprise-server@3.10/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list-for-authenticated-user": { parameters: { query?: { @@ -102027,20 +110985,30 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -102050,24 +111018,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key"][]; @@ -102079,13 +111048,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -102102,6 +111071,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -102113,21 +111085,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/get-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -102138,22 +111112,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. - */ "users/delete-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -102161,24 +111137,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization memberships for the authenticated user - * @description Lists all of the authenticated user's organization memberships. - */ "orgs/list-memberships-for-authenticated-user": { parameters: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-membership"][]; @@ -102190,19 +111169,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization membership for the authenticated user - * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. - */ "orgs/get-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -102211,15 +111194,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization membership for the authenticated user - * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. - */ "orgs/update-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -102235,6 +111218,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -102244,22 +111230,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List user migrations - * @description Lists all migrations a user has started. - */ "migrations/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -102270,11 +111259,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Start a user migration - * @description Initiates the generation of a user migration archive. - */ "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -102317,8 +111308,8 @@ export interface operations { /** * @description Exclude attributes from the API response to improve performance * @example [ - * "repositories" - * ] + * "repositories" + * ] */ exclude?: "repositories"[]; repositories: string[]; @@ -102328,6 +111319,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -102338,65 +111332,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Download a user migration archive - * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - */ "migrations/get-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories for a user migration - * @description Lists all the repositories for this user migration. - */ "migrations/list-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -102405,24 +111386,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organizations for the authenticated user - * @description List organizations for the authenticated user. - * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. - */ "orgs/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -102433,12 +111415,6 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List packages for the authenticated user's namespace - * @description Lists packages owned by the authenticated user within the user's namespace. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-authenticated-user": { parameters: { query: { @@ -102450,14 +111426,27 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -102465,104 +111454,112 @@ export interface operations { 400: components["responses"]["package_es_list_error"]; }; }; - /** - * Get a package for the authenticated user - * @description Gets a specific package for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for the authenticated user - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for the authenticated user - * @description Restores a package owned by the authenticated user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-authenticated-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by the authenticated user - * @description Lists package versions for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -102572,88 +111569,96 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for the authenticated user - * @description Gets a specific package version for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete a package version for the authenticated user - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package version for the authenticated user - * @description Restores a package version owned by the authenticated user. - * - * You can restore a deleted package version under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -102673,6 +111678,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -102683,26 +111691,25 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-public-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -102714,23 +111721,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories for the authenticated user - * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - */ "repos/list-for-authenticated-user": { parameters: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "public" | "private"; - /** - * @description Comma-separated list of values. Can include: - * * `owner`: Repositories that are owned by the authenticated user. - * * `collaborator`: Repositories that the user has been added to as a collaborator. - * * `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: + * * `owner`: Repositories that are owned by the authenticated user. + * * `collaborator`: Repositories that the user has been added to as a collaborator. + * * `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. */ affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ type?: "all" | "owner" | "public" | "private" | "member"; @@ -102738,15 +111737,26 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; + /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before-repo-date"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository"][]; }; @@ -102757,13 +111767,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a repository for the authenticated user - * @description Creates a new repository for the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -102855,34 +111865,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -102907,6 +111917,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -102920,22 +111931,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository invitations for the authenticated user - * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. - */ "repos/list-invitations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -102947,17 +111961,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Decline a repository invitation */ "repos/decline-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -102965,17 +111986,24 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** Accept a repository invitation */ "repos/accept-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -102983,22 +112011,25 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List social accounts for the authenticated user - * @description Lists all of your social accounts. - */ "users/list-social-accounts-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -103010,13 +112041,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -103031,6 +112062,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["social-account"][]; }; @@ -103042,13 +112076,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -103063,7 +112097,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103072,24 +112109,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/list-ssh-signing-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -103101,13 +112139,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. - */ "users/create-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -103124,6 +112162,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -103135,21 +112176,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/get-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -103160,22 +112203,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. - */ "users/delete-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103183,28 +112228,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories starred by the authenticated user - * @description Lists repositories the authenticated user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-authenticated-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository"][]; @@ -103216,48 +112262,61 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Check if a repository is starred by the authenticated user - * @description Whether the authenticated user has starred the repository. - */ "activity/check-repo-is-starred-by-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if this repository is starred by you */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description Not Found if this repository is not starred by you */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "activity/star-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103265,21 +112324,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unstar a repository for the authenticated user - * @description Unstar a repository that the authenticated user has previously starred. - */ "activity/unstar-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103287,22 +112351,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories watched by the authenticated user - * @description Lists repositories the authenticated user is watching. - */ "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -103313,27 +112380,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. - * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. - * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. - */ "teams/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-full"][]; @@ -103344,25 +112409,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List users - * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.10/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. - */ "users/list": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -103371,23 +112437,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a user - * @description Provides publicly available information about someone with a GitHub account. - * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#authentication). - * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.10/rest/users/emails)". - */ "users/get-by-username": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -103397,21 +112463,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get list of conflicting packages during Docker migration for user - * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -103420,92 +112488,114 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - */ "activity/list-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List organization events for the authenticated user - * @description This is the user's organization dashboard. You must be authenticated as the user to view this. - */ "activity/list-org-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events for a user */ "activity/list-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List followers of a user - * @description Lists the people following the specified user. - */ "users/list-followers-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -103513,25 +112603,28 @@ export interface operations { }; }; }; - /** - * List the people a user follows - * @description Lists the people who the specified user follows. - */ "users/list-following-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -103539,45 +112632,59 @@ export interface operations { }; }; }; - /** Check if a user follows another user */ "users/check-following-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; target_user: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the user follows the target user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if the user does not follow the target user */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List gists for a user - * @description Lists public gists for the specified user: - */ "gists/list-for-user": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -103586,25 +112693,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List GPG keys for a user - * @description Lists the GPG keys for a user. This information is accessible by anyone. - */ "users/list-gpg-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -103612,14 +112722,6 @@ export interface operations { }; }; }; - /** - * Get contextual information for a user - * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "users/get-context-for-user": { parameters: { query?: { @@ -103628,13 +112730,20 @@ export interface operations { /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ subject_id?: string; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hovercard"]; }; @@ -103643,46 +112752,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user installation for the authenticated app - * @description Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.10/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-user-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List public keys for a user - * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - */ "users/list-public-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key-simple"][]; @@ -103690,27 +112804,28 @@ export interface operations { }; }; }; - /** - * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.10/articles/publicizing-or-concealing-organization-membership) for the specified user. - * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.10/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. - */ "orgs/list-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -103718,12 +112833,6 @@ export interface operations { }; }; }; - /** - * List packages for a user - * @description Lists all packages in a user's namespace for which the requesting user has access. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-user": { parameters: { query: { @@ -103735,17 +112844,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -103755,106 +112877,113 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for a user - * @description Gets a specific package metadata for a public package owned by a user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for a user - * @description Restores an entire package for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by a user - * @description Lists package versions for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -103864,109 +112993,119 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for a user - * @description Gets a specific package version for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for a user - * @description Restores a specific package version for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.10/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List user projects - * @description Lists projects for a user. - */ "projects/list-for-user": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -103975,53 +113114,62 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. - */ "activity/list-received-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events received by a user */ "activity/list-received-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List repositories for a user - * @description Lists public repositories for the specified user. - */ "repos/list-for-user": { parameters: { query?: { @@ -104031,18 +113179,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -104050,59 +113205,70 @@ export interface operations { }; }; }; - /** - * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "enterprise-admin/promote-user-to-be-site-administrator": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Demote a site administrator - * @description You can demote any user account except your own. - */ "enterprise-admin/demote-site-administrator": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List social accounts for a user - * @description Lists social media accounts for a user. This endpoint is accessible by anyone. - */ "users/list-social-accounts-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -104110,25 +113276,28 @@ export interface operations { }; }; }; - /** - * List SSH signing keys for a user - * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. - */ "users/list-ssh-signing-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -104136,31 +113305,32 @@ export interface operations { }; }; }; - /** - * List repositories starred by a user - * @description Lists repositories a user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -104170,25 +113340,28 @@ export interface operations { }; }; }; - /** - * List repositories watched by a user - * @description Lists repositories a user is watching. - */ "activity/list-repos-watched-by-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -104196,19 +113369,15 @@ export interface operations { }; }; }; - /** - * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. - * - * You can suspend any user account except your own. - * - * 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 method](https://docs.github.com/enterprise-server@3.10/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "enterprise-admin/suspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -104221,19 +113390,22 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.10/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. - */ "enterprise-admin/unsuspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -104246,83 +113418,59 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the Zen of GitHub - * @description Get a random sentence from the Zen of GitHub - */ "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string; }; }; }; }; - /** - * Compare two commits - * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. - * - * 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. - * - * 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, 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)." - * - * 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 following fields are included in the `verification` object: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.10/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; base: string; head: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; diff --git a/packages/openapi-types-ghes-3.11/types.d.ts b/packages/openapi-types-ghes-3.11/types.d.ts index 0cf1e0b91..6168a02aa 100644 --- a/packages/openapi-types-ghes-3.11/types.d.ts +++ b/packages/openapi-types-ghes-3.11/types.d.ts @@ -3,366 +3,855 @@ * Do not make direct changes to the file. */ -/** OneOf type helpers */ -type Without = { [P in Exclude]?: never }; -type XOR = T | U extends object - ? (Without & U) | (Without & T) - : T | U; -type OneOf = T extends [infer Only] - ? Only - : T extends [infer A, infer B, ...infer Rest] - ? OneOf<[XOR, ...Rest]> - : never; - export interface paths { "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List global webhooks */ get: operations["enterprise-admin/list-global-webhooks"]; + put?: never; /** Create a global webhook */ post: operations["enterprise-admin/create-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a global webhook */ get: operations["enterprise-admin/get-global-webhook"]; + put?: never; + post?: never; /** Delete a global webhook */ delete: operations["enterprise-admin/delete-global-webhook"]; + options?: never; + head?: never; /** * Update a global webhook * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. */ patch: operations["enterprise-admin/update-global-webhook"]; + trace?: never; }; "/admin/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a global webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the webhook. */ post: operations["enterprise-admin/ping-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public keys */ get: operations["enterprise-admin/list-public-keys"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys/{key_ids}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a public key */ delete: operations["enterprise-admin/delete-public-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/ldap/teams/{team_id}/mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update LDAP mapping for a team * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ patch: operations["enterprise-admin/update-ldap-mapping-for-team"]; + trace?: never; }; "/admin/ldap/teams/{team_id}/sync": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync LDAP mapping for a team * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. */ post: operations["enterprise-admin/sync-ldap-mapping-for-team"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/ldap/users/{username}/mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** Update LDAP mapping for a user */ patch: operations["enterprise-admin/update-ldap-mapping-for-user"]; + trace?: never; }; "/admin/ldap/users/{username}/sync": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync LDAP mapping for a user * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. */ post: operations["enterprise-admin/sync-ldap-mapping-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an organization */ post: operations["enterprise-admin/create-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** Update an organization name */ patch: operations["enterprise-admin/update-org-name"]; + trace?: never; }; "/admin/pre-receive-environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List pre-receive environments */ get: operations["enterprise-admin/list-pre-receive-environments"]; + put?: never; /** Create a pre-receive environment */ post: operations["enterprise-admin/create-pre-receive-environment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive environment */ get: operations["enterprise-admin/get-pre-receive-environment"]; + put?: never; + post?: never; /** * Delete a pre-receive environment * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Cannot delete environment that has hooks_ + * * _Cannot delete environment when download is in progress_ */ delete: operations["enterprise-admin/delete-pre-receive-environment"]; + options?: never; + head?: never; /** * Update a pre-receive environment * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. */ patch: operations["enterprise-admin/update-pre-receive-environment"]; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a pre-receive environment download * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. + * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Can not start a new download when a download is in progress_ */ post: operations["enterprise-admin/start-pre-receive-environment-download"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the download status for a pre-receive environment * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. */ get: operations["enterprise-admin/get-download-status-for-pre-receive-environment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List pre-receive hooks */ get: operations["enterprise-admin/list-pre-receive-hooks"]; + put?: never; /** Create a pre-receive hook */ post: operations["enterprise-admin/create-pre-receive-hook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook */ get: operations["enterprise-admin/get-pre-receive-hook"]; + put?: never; + post?: never; /** Delete a pre-receive hook */ delete: operations["enterprise-admin/delete-pre-receive-hook"]; + options?: never; + head?: never; /** Update a pre-receive hook */ patch: operations["enterprise-admin/update-pre-receive-hook"]; + trace?: never; }; "/admin/tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List personal access tokens * @description Lists personal access tokens for all users, including admin users. */ get: operations["enterprise-admin/list-personal-access-tokens"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/tokens/{token_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a personal access token * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. */ delete: operations["enterprise-admin/delete-personal-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * - * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. + * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * - * If the login name or email address is already associated with an account, the server will return a `422` response. + * If the login name or email address is already associated with an account, the server will return a `422` response. */ post: operations["enterprise-admin/create-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a user * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#suspend-a-user) is often a better option. * - * You can delete any user account except your own. + * You can delete any user account except your own. */ delete: operations["enterprise-admin/delete-user"]; + options?: never; + head?: never; /** Update the username for a user */ patch: operations["enterprise-admin/update-username-for-user"]; + trace?: never; }; "/admin/users/{username}/authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an impersonation OAuth token */ post: operations["enterprise-admin/create-impersonation-o-auth-token"]; /** Delete an impersonation OAuth token */ delete: operations["enterprise-admin/delete-impersonation-o-auth-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List global security advisories * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." */ get: operations["security-advisories/list-global-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a global security advisory * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. */ get: operations["security-advisories/get-global-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated app * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installations for the authenticated app * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * - * The permissions the installation has are included under the `permissions` key. + * The permissions the installation has are included under the `permissions` key. */ get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. + * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/grants": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List your grants * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ get: operations["oauth-authorizations/list-grants"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/grants/{grant_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a single grant * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/get-grant"]; + put?: never; + post?: never; /** * Delete a grant * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["oauth-authorizations/delete-grant"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. @@ -373,760 +862,1532 @@ export interface paths { * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. */ delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; + trace?: never; }; "/applications/{client_id}/token/scoped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a scoped access token * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. + * which repositories the token can access and which permissions are granted to the + * token. * - * Invalid tokens will return `404 NOT FOUND`. + * Invalid tokens will return `404 NOT FOUND`. * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. + * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ post: operations["apps/scope-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List your authorizations * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/list-authorizations"]; + put?: never; /** * Create a new authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. * - * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.11/articles/creating-an-access-token-for-command-line-use). + * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.11/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.11/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.11/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ post: operations["oauth-authorizations/create-authorization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/clients/{client_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Get-or-create an authorization for a specific app * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/clients/{client_id}/{fingerprint}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/{authorization_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a single authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/get-authorization"]; + put?: never; + post?: never; /** * Delete an authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ delete: operations["oauth-authorizations/delete-authorization"]; + options?: never; + head?: never; /** * Update an existing authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * You can only send one of these scope keys at a time. + * You can only send one of these scope keys at a time. */ patch: operations["oauth-authorizations/update-authorization"]; + trace?: never; }; "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get emojis * @description Lists all the emojis available to use on GitHub Enterprise Server. */ get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the global announcement banner * @description Gets the current message and expiration date of the global announcement banner in your enterprise. */ get: operations["enterprise-admin/get-announcement"]; + put?: never; + post?: never; /** * Remove the global announcement banner * @description Removes the global announcement banner in your enterprise. */ delete: operations["enterprise-admin/remove-announcement"]; + options?: never; + head?: never; /** * Set the global announcement banner * @description Sets the message and expiration time for the global announcement banner in your enterprise. */ patch: operations["enterprise-admin/set-announcement"]; + trace?: never; }; "/enterprise/settings/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get license information */ get: operations["enterprise-admin/get-license-information"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/all": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all statistics */ get: operations["enterprise-admin/get-all-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get comment statistics */ get: operations["enterprise-admin/get-comment-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get gist statistics */ get: operations["enterprise-admin/get-gist-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get hooks statistics */ get: operations["enterprise-admin/get-hooks-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get issue statistics */ get: operations["enterprise-admin/get-issue-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get milestone statistics */ get: operations["enterprise-admin/get-milestone-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get organization statistics */ get: operations["enterprise-admin/get-org-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pages statistics */ get: operations["enterprise-admin/get-pages-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pull request statistics */ get: operations["enterprise-admin/get-pull-request-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get repository statistics */ get: operations["enterprise-admin/get-repo-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/security-products": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get security products statistics * @description Gets the statistics about security products for a GitHub Enterprise Server instance. * - * To use this endpoint, you must be a site admin. + * To use this endpoint, you must be a site admin. */ get: operations["enterprise-admin/get-security-products"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get users statistics */ get: operations["enterprise-admin/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an enterprise * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/cache/usage-policy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage policy for an enterprise * @description Gets the GitHub Actions cache usage policy for an enterprise. * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-policy-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set GitHub Actions cache usage policy for an enterprise * @description Sets the GitHub Actions cache usage policy for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ patch: operations["actions/set-actions-cache-usage-policy-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an enterprise * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; /** * Set GitHub Actions permissions for an enterprise * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; /** * Set selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected organization for GitHub Actions in an enterprise * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + post?: never; /** * Disable a selected organization for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an enterprise * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-allowed-actions-enterprise"]; /** * Set allowed actions for an enterprise * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-allowed-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an enterprise * @description 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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-enterprise"]; /** * Set default workflow permissions for an enterprise * @description 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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * 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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an enterprise * @description Lists all self-hosted runner groups for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + put?: never; /** * Create a self-hosted runner group for an enterprise * @description Creates a new self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an enterprise * @description Gets a specific self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an enterprise * @description Deletes a self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an enterprise * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization access to a self-hosted runner group in an enterprise * @description Lists the organizations with access to a self-hosted runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Set organization access for a self-hosted runner group in an enterprise * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add organization access to a self-hosted runner group in an enterprise * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; /** * Remove organization access to a self-hosted runner group in an enterprise * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an enterprise * @description Lists the self-hosted runners that are in a specific enterprise group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Set self-hosted runners in a group for an enterprise * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an enterprise * @description Adds a self-hosted runner to a runner group configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + post?: never; /** * Remove a self-hosted runner from a group for an enterprise * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an enterprise * @description Lists all self-hosted runners configured for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an enterprise * @description Lists binaries for the runner application that you can download and run. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an Enterprise * @description Generates a configuration that can be passed to the runner application at startup. * - * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an enterprise * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * Example using registration token: + * Example using registration token: * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-registration-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an enterprise * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * Example using remove token: + * Example using remove token: * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-remove-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an enterprise * @description Gets a specific self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an enterprise * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an enterprise * @description Lists all labels for a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; /** * Set custom labels for a self-hosted runner for an enterprise * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. + * self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; /** * Add custom labels to a self-hosted runner for an enterprise * @description Add custom labels to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; /** * Remove all custom labels from a self-hosted runner for an enterprise * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. + * enterprise. Returns the remaining read-only labels from the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an enterprise * @description Remove a custom label from a self-hosted runner configured - * in an enterprise. Returns the remaining labels from the runner. + * 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an enterprise * @description Gets the audit log for an enterprise. * - * The authenticated user must be an enterprise admin to use this endpoint. + * The authenticated user must be an enterprise admin to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an enterprise * @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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. */ get: operations["code-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code_security_and_analysis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get code security and analysis features for an enterprise * @description Gets code security and analysis settings for the specified enterprise. * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["secret-scanning/get-security-analysis-settings-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update code security and analysis features for an enterprise * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ patch: operations["secret-scanning/patch-security-analysis-settings-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * 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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * 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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ get: operations["dependabot/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an enterprise * @description 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/enterprise-server@3.11/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. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ get: operations["secret-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an enterprise * @description 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-ghe"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature * @description Enables or disables the specified security feature for all repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ post: operations["secret-scanning/post-security-product-enablement-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public events * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ get: operations["activity/list-public-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get feeds * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * - * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. + * * **Timeline**: The GitHub Enterprise Server global public timeline + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List starred gists * @description List the authenticated user's starred gists: */ get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @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. */ patch: operations["gists/update"]; + trace?: never; }; "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update-comment"]; + trace?: never; }; "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist commits */ get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist forks */ get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a gist is starred */ get: operations["gists/check-is-starred"]; /** @@ -1134,144 +2395,362 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; + post?: never; /** Unstar a gist */ delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. */ get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issues assigned to the authenticated user * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/config/nodes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GHES node metadata for all nodes * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.11/admin/enterprise-management/configuring-clustering/about-clustering)." */ get: operations["enterprise-admin/get-config-nodes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/maintenance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the status of maintenance mode * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ get: operations["enterprise-admin/get-manage-maintenance"]; + put?: never; /** * Set the status of maintenance mode * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." */ post: operations["enterprise-admin/set-manage-maintenance"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/replication/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the status of services running on all replica nodes * @description Gets the status of all services running on each replica node. - * This endpoint may take several seconds to reply. + * This endpoint may take several seconds to reply. */ get: operations["enterprise-admin/get-replication-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/version": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all GHES release versions for all nodes * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.11/admin/all-releases)." */ get: operations["enterprise-admin/get-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Render a Markdown document */ post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get GitHub Enterprise Server meta information */ get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/networks/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a network of repositories */ get: operations["activity/list-public-events-for-repo-network"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. @@ -1282,192 +2761,327 @@ export interface paths { * @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 Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. */ patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread subscription for the authenticated user * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription). * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Octocat * @description Get the octocat as ASCII art */ get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations/{organization_id}/custom_roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Deprecated - List custom repository roles in an organization * @deprecated * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-roles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/). * - * To see the full details about an organization, the authenticated user must be an organization owner. + * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * - * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. + * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. */ get: operations["orgs/get"]; + put?: never; + post?: never; /** * Delete an organization * @description Deletes an organization and all its repositories. * - * The organization login will be unavailable for 90 days after deletion. + * The organization login will be unavailable for 90 days after deletion. * - * Please review the Terms of Service regarding account deletion before using this endpoint: + * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.11/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.11/site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; + options?: never; + head?: never; /** * Update an organization * @description **Parameter Deprecation Notice:** GitHub Enterprise Server 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). * - * Updates the organization's profile and member privileges. + * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ patch: operations["orgs/update"]; + trace?: never; }; "/orgs/{org}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an organization * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/cache/usage-by-repository": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["oidc/update-oidc-custom-sub-template-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories enabled for GitHub Actions in an organization * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** @@ -1475,1053 +3089,1717 @@ export interface paths { * @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)." * * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an organization * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions for an organization * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an organization * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; /** * Create a self-hosted runner group for an organization * @description Creates a new self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an organization * @description Gets a specific self-hosted runner group for an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an organization * @description Deletes a self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an organization * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository access to a self-hosted runner group in an organization * @description Lists the repositories with access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; /** * Set repository access for a self-hosted runner group in an organization * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add repository access to a self-hosted runner group in an organization * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; /** * Remove repository access to a self-hosted runner group in an organization * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an organization * @description Lists self-hosted runners that are in a specific organization group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-in-group-for-org"]; /** * Set self-hosted runners in a group for an organization * @description Replaces the list of self-hosted runners that are part of an organization runner group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an organization * @description Adds a self-hosted runner to a runner group configured in an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; /** * Remove a self-hosted runner from a group for an organization * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the organization. + * The authenticated user must have admin access to the organization. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** * Set custom labels for a self-hosted runner for an organization * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. + * self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization * @description Adds custom labels to a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** * Remove all custom labels from a self-hosted runner for an organization * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. + * organization. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an organization * @description Remove a custom label from a self-hosted runner configured - * in an organization. Returns the remaining labels from the runner. + * in an organization. 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * The authenticated user must have collaborator access to a repository to create, update, or read secrets * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to + * use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. For more information about setting the visibility, see [Create or + * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization variables * @description Lists all organization variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-variables"]; + put?: never; /** * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-org-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization variable * @description Gets a specific variable in an organization. * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-variable"]; + put?: never; + post?: never; /** * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-variable"]; + options?: never; + head?: never; /** * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ patch: operations["actions/update-org-variable"]; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization variable * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. + * that is available to selected repositories. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-variable"]; /** * Set selected repositories for an organization variable * @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`. + * to selected repositories. Organization variables that are available to selected + * repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-variable"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization variable * @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`. + * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-variable"]; + post?: never; /** * Remove selected repository from an organization variable * @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`. + * available to selected repositories. Organization variables that are available to + * selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-variable"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get announcement banner for organization * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. + * organization level. Organization members may also see an enterprise-level announcement banner. To get an + * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. */ get: operations["announcement-banners/get-announcement-banner-for-org"]; + put?: never; + post?: never; /** * Remove announcement banner from organization * @description Removes the announcement banner currently set for the organization. */ delete: operations["announcement-banners/remove-announcement-banner-for-org"]; + options?: never; + head?: never; /** * Set announcement banner for organization * @description Sets the announcement banner to display for the organization. */ patch: operations["announcement-banners/set-announcement-banner-for-org"]; + trace?: never; }; "/orgs/{org}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an organization * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. */ get: operations["orgs/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom repository roles in an organization * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-repo-roles"]; + put?: never; /** * Create a custom repository role * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-repo-role"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom repository role * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/get-custom-repo-role"]; + put?: never; + post?: never; /** * Delete a custom repository role * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-repo-role"]; + options?: never; + head?: never; /** * Update a custom repository role * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/update-custom-repo-role"]; + trace?: never; }; "/orgs/{org}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization + * permission to use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["dependabot/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public organization events */ get: operations["activity/list-public-org-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-group/{group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization webhooks * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description Create a hook that posts payloads in JSON format. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization webhook * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** * Delete an organization webhook * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping an organization webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) - * to be sent to the hook. + * to be sent to the hook. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations for an organization * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. + * all GitHub Apps installed on repositories in the organization. * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. @@ -2531,291 +4809,591 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * - * **Rate limits** + * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization migrations * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). * - * A list of `repositories` is only returned for export migrations. + * A list of `repositories` is only returned for export migrations. */ get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. * - * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.11/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.11/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization migration status * @description Fetches the status of a migration. * - * The `state` of a migration can be one of the following values: + * The `state` of a migration can be one of the following values: * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Convert an organization member to outside collaborator * @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/enterprise-server@3.11/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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; + put?: never; + post?: never; /** * Delete a package for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for an organization * @description Restores an entire package in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; + put?: never; + post?: never; /** * Delete package version for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for an organization * @description Restores a specific package version in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List requests to access organization resources with fine-grained personal access tokens * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-requests"]; + put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-requests-in-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review a request to access organization resources with a fine-grained personal access token * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories requested to be accessed by a fine-grained personal access token * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-request-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List fine-grained personal access tokens with access to organization resources * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grants"]; + put?: never; /** * Update the access to organization resources via fine-grained personal access tokens * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-accesses"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Update the access a fine-grained personal access token has to organization resources * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-access"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories a fine-grained personal access token has access to * @description Lists the repositories a fine-grained personal access token has access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pre-receive hooks for an organization * @description List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. */ get: operations["enterprise-admin/list-pre-receive-hooks-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook for an organization */ get: operations["enterprise-admin/get-pre-receive-hook-for-org"]; + put?: never; + post?: never; /** * Remove pre-receive hook enforcement for an organization * @description Removes any overrides for this hook at the org level for this org. */ delete: operations["enterprise-admin/remove-pre-receive-hook-enforcement-for-org"]; + options?: never; + head?: never; /** * Update pre-receive hook enforcement for an organization * @description For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration` */ patch: operations["enterprise-admin/update-pre-receive-hook-enforcement-for-org"]; + trace?: never; }; "/orgs/{org}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-org"]; + put?: never; /** * Create an organization project * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. */ get: operations["orgs/list-public-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check public organization membership for a user * @description Check if the provided user is a public member of the organization. @@ -2825,55 +5403,103 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; + post?: never; /** * Remove public organization membership for the authenticated user * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization repositories * @description 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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repository-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository fine-grained permissions for an organization * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-repo-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all organization repository rulesets * @description Get all the repository rulesets for an organization. */ get: operations["repos/get-org-rulesets"]; + put?: never; /** * Create an organization repository ruleset * @description Create a repository ruleset for an organization. */ post: operations["repos/create-org-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. @@ -2884,1386 +5510,2553 @@ export interface paths { * @description Update a ruleset for an organization. */ put: operations["repos/update-org-ruleset"]; + post?: never; /** * Delete an organization repository ruleset * @description Delete a ruleset for an organization. */ delete: operations["repos/delete-org-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List security manager teams * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-security-manager-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a security manager team * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["orgs/add-security-manager-team"]; + post?: never; /** * Remove a security manager team * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-security-manager-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an organization * @description 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. + * 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ get: operations["teams/list"]; + put?: never; /** * Create a team * @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/enterprise-server@3.11/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/enterprise-server@3.11/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/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-in-org"]; + put?: never; /** * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-in-org"]; + put?: never; + post?: never; /** * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-in-org"]; + options?: never; + head?: never; /** * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-in-org"]; + put?: never; /** * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * **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`. + * **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`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-in-org"]; + put?: never; + post?: never; /** * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-in-org"]; + options?: never; + head?: never; /** * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; + put?: never; /** * Create reaction for a team discussion comment * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; + put?: never; /** * Create reaction for a team discussion * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; + put?: never; + post?: never; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + options?: never; + head?: never; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members * @description Team members will include the members of child teams. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user * @description Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/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. + * 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. * - * If 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. + * If 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. * - * **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}`. + * **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}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @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. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/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}`. + * **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}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; + post?: never; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **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}`. + * **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/enterprise-server@3.11/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/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature for an organization * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/cards/{card_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project card * @description Gets information about a project card. */ get: operations["projects/get-card"]; + put?: never; + post?: never; /** * Delete a project card * @description Deletes a project card */ delete: operations["projects/delete-card"]; + options?: never; + head?: never; /** Update an existing project card */ patch: operations["projects/update-card"]; + trace?: never; }; "/projects/columns/cards/{card_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project card */ post: operations["projects/move-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project column * @description Gets information about a project column. */ get: operations["projects/get-column"]; + put?: never; + post?: never; /** * Delete a project column * @description Deletes a project column. */ delete: operations["projects/delete-column"]; + options?: never; + head?: never; /** Update an existing project column */ patch: operations["projects/update-column"]; + trace?: never; }; "/projects/columns/{column_id}/cards": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project cards * @description Lists the project cards in a project. */ get: operations["projects/list-cards"]; + put?: never; /** Create a project card */ post: operations["projects/create-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project column */ post: operations["projects/move-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/get"]; + put?: never; + post?: never; /** * Delete a project * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ delete: operations["projects/delete"]; + options?: never; + head?: never; /** * Update a project * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ patch: operations["projects/update"]; + trace?: never; }; "/projects/{project_id}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project collaborators * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ get: operations["projects/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add project collaborator * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ put: operations["projects/add-collaborator"]; + post?: never; /** * Remove user as a collaborator * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ delete: operations["projects/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get project permission for a user * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ get: operations["projects/get-permission-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/columns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project columns * @description Lists the project columns in a project. */ get: operations["projects/list-columns"]; + put?: never; /** * Create a project column * @description Creates a new project column. */ post: operations["projects/create-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.11/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.11/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.11/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.11/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.11/rest/overview/api-versions)." + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.11/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.11/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.11/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.11/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.11/rest/overview/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository * @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. * - * **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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List artifacts for a repository * @description Lists all artifacts for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an artifact * @description Gets a specific artifact for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an artifact * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. - * 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. + * 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. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage-policy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage policy for a repository * @description Gets GitHub Actions cache usage policy for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-policy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set GitHub Actions cache usage policy for a repository * @description Sets GitHub Actions cache usage policy for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/set-actions-cache-usage-policy"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-list"]; + put?: never; + post?: never; /** * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a job for a workflow run * @description Gets a specific job in a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. + * for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization secrets * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization variables * @description Lists all organization variables shared with a repository. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-variables"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * - * You 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. + * You 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. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-workflow-access-to-repository"]; /** * Set the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-workflow-access-to-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for a repository * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You 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. + * You 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. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions for a repository * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/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)." + * as well as if GitHub Actions can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/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)." + * can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the repository. + * The authenticated user must have admin access to the repository. * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** * Set custom labels for a self-hosted runner for a repository * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. + * self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository * @description Adds custom labels to a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** * Remove all custom labels from a self-hosted runner for a repository * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. + * repository. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for a repository * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. + * in a repository. Returns the remaining labels from the runner. * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a repository * @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/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run * @description Gets a specific workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Deletes a specific workflow run. * - * Anyone with write access to the repository can use this endpoint. + * Anyone with write access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the review history for a workflow run * @description Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-reviews-for-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow run artifacts * @description Lists artifacts for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run attempt * @description Gets a specific workflow run attempt. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * **Note:** GitHub Apps can only review their own custom deployment protection rules. + * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ post: operations["actions/review-custom-gates-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. + * `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @description Deletes all logs for a workflow run. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-pending-deployments-for-run"]; + put?: never; /** * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/review-pending-deployments-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a workflow * @description Re-runs your workflow run using its `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run failed jobs from a workflow run * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow-failed-jobs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository variables * @description Lists all repository variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-variables"]; + put?: never; /** * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-repo-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository variable * @description Gets a specific variable in a repository. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-variable"]; + put?: never; + post?: never; /** * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-variable"]; + options?: never; + head?: never; /** * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-repo-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository workflows * @description Lists the workflows in a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow * @description Gets a specific workflow. You can replace `workflow_id` with the workflow - * file name. For example, you could use `main.yaml`. + * file name. For example, you could use `main.yaml`. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Disable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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`. * - * You 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)." + * You 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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a workflow * @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/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint + * Anyone with read access to the repository can use this endpoint * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository activities * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * - * For more information about viewing repository activity, - * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository)." + * For more information about viewing repository activity, + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository)." */ get: operations["repos/list-activities"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.11/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned * @description Checks if a user has permission to be assigned to an issue in this repository. * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. * - * Otherwise a `404` status code is returned. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an autolink reference of a repository * @description This returns a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if automated security fixes are enabled for a repository * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.11/articles/configuring-automated-security-fixes)". */ get: operations["repos/check-automated-security-fixes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List branches */ get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a branch */ get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get branch protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -4273,106 +8066,161 @@ export interface paths { * Update branch protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Protecting a branch requires admin or owner permissions to the repository. + * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get admin branch protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pull request review protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit signature protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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/enterprise-server@3.11/articles/signing-commits-with-gpg) in GitHub Help. + * When 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/enterprise-server@3.11/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * **Note**: You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get status checks protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ patch: operations["repos/update-status-check-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all status check contexts * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -4393,1841 +8241,3102 @@ export interface paths { * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists who has access to this protected branch. + * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Disables the ability to restrict who can push to this branch. + * Disables the ability to restrict who can push to this branch. */ delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get apps with access to the protected branch * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * 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/enterprise-server@3.11/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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * 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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get teams with access to the protected branch * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. The list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified teams push access for this branch. You can also give push access to child teams. + * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get users with access to the protected branch * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the people who have push access to this branch. + * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ put: operations["repos/set-user-access-restrictions"]; /** * Add user 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified people push access for this branch. + * Grants the specified people push access for this branch. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ post: operations["repos/add-user-access-restrictions"]; /** * Remove user 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a user to push to this branch. + * Removes the ability of a user to push to this branch. * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/rename": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rename a branch * @description Renames a branch in a repository. * - * **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/enterprise-server@3.11/github/administering-a-repository/renaming-a-branch)". + * **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/enterprise-server@3.11/github/administering-a-repository/renaming-a-branch)". * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ post: operations["repos/rename-branch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check run * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ patch: operations["checks/update"]; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check run annotations * @description Lists annotations for a check run using the annotation `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch (or for the specified Git reference if you used `ref` in the request). * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning alert * @description Gets a single code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning analyses for a repository * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `category` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set: + * `next_analysis_url` and `confirm_delete_url`. + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in a set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find an analysis that's identified as deletable. + * Each set of analyses always has one that's identified as deletable. + * Having found the deletable analysis for one of the two sets, + * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + * Then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-default-setup"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-default-setup"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif)." * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - 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)." * - * You 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: + * You 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: * - * ``` - * gzip -c analysis-data.sarif | base64 -w0 - * ``` + * ``` + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. | + * | **SARIF data** | **Maximum values** | **Additional limits** | + * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| + * | Runs per file | 20 | | + * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * The `202 Accepted` response includes an `id` value. + * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS - * file. + * file. * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * For more information about the correct CODEOWNERS syntax, + * see "[About code owners](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is a repository collaborator * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/check-collaborator"]; /** * Add a repository collaborator * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * 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-server@3.11/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-server@3.11/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/enterprise-server@3.11/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: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/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: * - * ``` - * Cannot assign {member} permission of {role name} - * ``` + * ``` + * Cannot assign {member} permission of {role name} + * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Updating an existing collaborator's permission level** + * **Updating an existing collaborator's permission level** * - * The 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. + * The 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. */ put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. + * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages + * This endpoint also: + * - Cancels any outstanding invitations + * - Unasigns the user from any issues + * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. + * - Unstars the repository + * - Updates access permissions to packages * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + * Removing a user as a collaborator has the following effects on forks: + * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + * - If the user had their own fork of the repository, the fork will be deleted. + * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. + * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository permissions for a user * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * permissions are `admin`, `write`, `read`, and `none`. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the + * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. */ get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["repos/update-commit-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List branches for HEAD commit * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests associated with a commit * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * - * **Signature verification object** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.11/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.11/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.11/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.11/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the combined status for a specific reference * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * * - * Additionally, a combined `state` is returned. The `state` is one of: + * Additionally, a combined `state` is returned. The `state` is one of: * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` */ get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit statuses for a reference * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * - * 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 API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. + * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. * - * **Working with large comparisons** + * **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: + * 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. + * - 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. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." * - * **Signature verification object** + * **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 `verification` object includes the following fields: * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits-with-basehead"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * - * **Notes**: + * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository contributors * @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. * - * 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. + * 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. */ get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for a repository * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a Dependabot alert * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a Dependabot alert * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["dependabot/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @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. + * encrypt a secret before you can create or update secrets. Anyone with read access + * to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ get: operations["dependabot/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["dependabot/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["dependabot/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a diff of the dependencies between commits * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */ get: operations["dependency-graph/diff-range"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/sbom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Export a software bill of materials (SBOM) for a repository. * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. */ get: operations["dependency-graph/export-sbom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a snapshot of dependencies for a repository * @description Create a new snapshot of a repository's dependencies. * - * The authenticated user must have access to the repository. + * The authenticated user must have access to the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["dependency-graph/create-repository-snapshot"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them - * before we merge a pull request. + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them + * before we merge a pull request. * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. * - * Merged branch response: + * Merged branch response: * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. * - * Merge conflict response: + * Merge conflict response: * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. * - * Failed commit status checks: + * Failed commit status checks: * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deployment */ get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * 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. * - * To set a deployment as inactive, you must: + * To set a deployment as inactive, you must: * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. + * * 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/enterprise-server@3.11/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#create-a-deployment-status)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#repository_dispatch)." * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * This input example shows how you can use the `client_payload` as a test to debug your workflow. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment * @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)." * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-environment"]; /** * Create or update an environment * @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)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all deployment protection rules for an environment * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-deployment-protection-rules"]; + put?: never; /** * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-protection-rule"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom deployment rule integrations available for an environment * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app)". * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-custom-deployment-rule-integrations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom deployment protection rule * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-custom-deployment-protection-rule"]; + put?: never; + post?: never; /** * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/disable-deployment-protection-rule"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment secrets * @description Lists all secrets available in an environment without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment public key * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. + * 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. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment secret * @description Gets a single environment secret without revealing its encrypted value. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-secret"]; /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-environment-secret"]; + post?: never; /** * Delete an environment secret * @description Deletes a secret in an environment using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment variables * @description Lists all environment variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-variables"]; + put?: never; /** * Create an environment variable * @description Create an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment variable * @description Gets a specific variable in an environment. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; /** * Delete an environment variable * @description Deletes an environment variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; /** * Update an environment variable * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-environment-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * */ get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List forks */ get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * - **`application/vnd.github.raw+json`**: Returns the raw blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. * - * **Note** This endpoint supports blobs up to 100 megabytes in size. + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit object * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." + * + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List matching references * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a reference * @description Deletes the provided reference. */ delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** * Update a reference * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ patch: operations["git/update-ref"]; + trace?: never; }; "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tag * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.11/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.11/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.11/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.11/rest/git/refs#update-a-reference)." * - * Returns an error if you try to delete a file that does not exist. + * Returns an error if you try to delete a file that does not exist. */ post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tree * @description Returns a single tree using the SHA1 value or ref name for that tree. * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. + * share the same `config` as long as those webhooks do not have any `events` that overlap. */ post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ patch: operations["repos/update-invitation"]; + trace?: never; }; "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.11/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments for a repository * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * - * By default, issue comments are ordered by ascending ID. + * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events for a repository * @description Lists events for a repository. */ get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue event * @description Gets a single event by the event id. */ get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.11/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-server@3.11/webhooks/event-payloads/#issues) webhook. + * [transferred](https://docs.github.com/enterprise-server@3.11/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * 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/enterprise-server@3.11/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 - * 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/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. @@ -6238,59 +11347,107 @@ export interface paths { * @description Removes one or more assignees from an issue. */ delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned to a issue * @description 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. + * 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. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * Issue comments are ordered by ascending ID. + * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events * @description Lists all events for an issue. */ get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for an issue * @description Lists all labels for an issue. @@ -6311,183 +11468,403 @@ export interface paths { * @description Removes all labels from an issue. */ delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List deploy keys */ get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deploy key */ get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a repository * @description Lists all labels for a repository. */ get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a label * @description Gets a label using the given name. */ get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ patch: operations["issues/update-label"]; + trace?: never; }; "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable Git LFS for a repository * @description Enables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["repos/enable-lfs-for-repo"]; + post?: never; /** * Disable Git LFS for a repository * @description Disables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["repos/disable-lfs-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List milestones * @description Lists milestones for a repository. */ get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ patch: operations["issues/update-milestone"]; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. @@ -6498,352 +11875,585 @@ export interface paths { * @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 Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GitHub Enterprise Server Pages site * @description Gets information about a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub Enterprise Server Pages site * @description Updates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Enterprise Server Pages site * @description Configures a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub Enterprise Server Pages site * @description Deletes a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Enterprise Server Pages builds * @description Lists builts of a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub Enterprise Server Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Enterprise Server Pages build * @description Gets information about a GitHub Enterprise Server Pages build. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * The authenticated user must have write permission to the repository. + * The authenticated user must have write permission to the repository. */ post: operations["repos/create-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pre-receive hooks for a repository * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. */ get: operations["enterprise-admin/list-pre-receive-hooks-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook for a repository */ get: operations["enterprise-admin/get-pre-receive-hook-for-repo"]; + put?: never; + post?: never; /** * Remove pre-receive hook enforcement for a repository * @description Deletes any overridden enforcement on this repository for the specified hook. * - * Responds with effective values inherited from owner and/or global level. + * Responds with effective values inherited from owner and/or global level. */ delete: operations["enterprise-admin/remove-pre-receive-hook-enforcement-for-repo"]; + options?: never; + head?: never; /** * Update pre-receive hook enforcement for a repository * @description For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` */ patch: operations["enterprise-admin/update-pre-receive-hook-enforcement-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-repo"]; + put?: never; /** * Create a repository project * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests * @description Lists pull requests in a specified repository. * - * 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. + * 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments in a repository * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. + * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists details of a pull request by providing its number. + * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments on a pull request * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. + * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#create-an-issue-comment)." * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reply for a review comment * @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. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits) - * endpoint. + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits) + * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. @@ -6852,16 +12462,29 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. @@ -6872,308 +12495,567 @@ export interface paths { * @description Removes review requests from a pull request for a given set of users and/or teams. */ delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * 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/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/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. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) endpoint. * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List releases * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-tags). * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release asset * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ patch: operations["repos/update-release-asset"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/generate-notes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Generate release notes content for a release * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the latest release * @description View the latest published full release for the repository. * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ patch: operations["repos/update-release"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List release assets */ get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#create-a-release) to upload a release asset. + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#create-a-release) to upload a release asset. * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: * - * `application/zip` + * `application/zip` * - * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. + * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * - * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.11/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + * **Notes:** + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.11/rest/releases/assets#list-release-assets)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-the-latest-release). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/replicas/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository cache replication status * @description Lists the status of each repository cache replica. */ get: operations["repos/list-cache-info"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rules/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rules for a branch * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply - * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level - * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" - * enforcement statuses are not returned. + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. */ get: operations["repos/get-branch-rules"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all repository rulesets * @description Get all the rulesets for a repository. */ get: operations["repos/get-repo-rulesets"]; + put?: never; /** * Create a repository ruleset * @description Create a ruleset for a repository. */ post: operations["repos/create-repo-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository ruleset * @description Get a ruleset for a repository. @@ -7184,133 +13066,286 @@ export interface paths { * @description Update a ruleset for a repository. */ put: operations["repos/update-repo-ruleset"]; + post?: never; /** * Delete a repository ruleset * @description Delete a ruleset for a repository. */ delete: operations["repos/delete-repo-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["secret-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit activity * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all contributor commit activity * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits */ get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit count * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * - * The array order is oldest week (index 0) to most recent week. + * The array order is oldest week (index 0) to most recent week. * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. + * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the hourly commit count for each day * @description Each array contains the day number, hour number, and number of commits: * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List watchers * @description Lists the people watching the specified repository. */ get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. @@ -7321,74 +13356,174 @@ export interface paths { * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List repository tags */ get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List tag protection states for a repository * @description This returns the tag protection states of a repository. * - * This information is only available to repository administrators. + * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; + put?: never; /** * Create a tag protection state for a repository * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a tag protection state for a repository * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (tar) * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * `main`) 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. */ get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository teams * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. * - * For a public repository, a team is listed only if that team added the public repository explicitly. + * For a public repository, a team is listed only if that team added the public repository explicitly. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all repository topics */ get: operations["repos/get-all-topics"]; /** Replace all repository topics */ put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.11/articles/about-repository-transfers/). */ post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if vulnerability alerts are enabled for a repository * @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/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". @@ -7399,350 +13534,586 @@ export interface paths { * @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/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". */ put: operations["repos/enable-vulnerability-alerts"]; + post?: never; /** * Disable vulnerability alerts * @description Disables dependency alerts 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/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". + * The authenticated user must have admin access to the repository. For more information, + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". */ delete: operations["repos/disable-vulnerability-alerts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (zip) * @description 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 - * the `Location` header to make a second `GET` request. + * `main`) 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. + * **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. */ get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public repositories * @description Lists all public repositories in the order that they were created. * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Lists provisioned SCIM groups in an enterprise. + * Lists provisioned SCIM groups in an enterprise. * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. + * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. */ get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + put?: never; /** * Provision a SCIM enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Creates a SCIM group for an enterprise. + * Creates a SCIM group for an enterprise. * - * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. + * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ post: operations["enterprise-admin/provision-enterprise-group"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Gets information about a SCIM group. + * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Replaces an existing provisioned group’s information. + * Replaces an existing provisioned group’s information. * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + post?: never; /** * Delete a SCIM group from an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Update a provisioned group’s individual attributes. + * Update a provisioned group’s individual attributes. * - * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. + * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. * - * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. + * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Lists provisioned SCIM enterprise members. + * Lists provisioned SCIM enterprise members. * - * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. + * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. */ get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + put?: never; /** * Provision a SCIM enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Creates an external identity for a new SCIM enterprise user. + * Creates an external identity for a new SCIM enterprise user. * - * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. + * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. * - * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. + * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ post: operations["enterprise-admin/provision-enterprise-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Gets information about a SCIM user. + * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Replaces an existing provisioned user's information. + * Replaces an existing provisioned user's information. * - * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. + * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + post?: never; /** * Delete a SCIM user from an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. + * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Update a provisioned user's individual attributes. + * Update a provisioned user's individual attributes. * - * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false + * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] * } - * }] - * } - * ``` + * ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; + trace?: never; }; "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * - * `q=addClass+in:file+language:js+repo:jquery/jquery` + * `q=addClass+in:file+language:js+repo:jquery/jquery` * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. * - * Considerations for code search: + * Considerations for code search: * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search commits * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). * - * 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/enterprise-server@3.11/rest/search/search#text-match-metadata). + * 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/enterprise-server@3.11/rest/search/search#text-match-metadata). * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * - * `q=repo:octocat/Spoon-Knife+css` + * `q=repo:octocat/Spoon-Knife+css` */ get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search issues and pull requests * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.11/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.11/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * - * `q=bug+defect+enhancement&repository_id=64778136` + * `q=bug+defect+enhancement&repository_id=64778136` * - * The labels that best match the query appear first in the search results. + * The labels that best match the query appear first in the search results. */ get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * - * `q=tetris+language:assembly&sort=stars&order=desc` + * `q=tetris+language:assembly&sort=stars&order=desc` * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.11/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * - * `q=ruby+is:featured` + * `q=ruby+is:featured` * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). * - * For example, if you're looking for a list of popular users, you might try this query: + * For example, if you're looking for a list of popular users, you might try this query: * - * `q=tom+repos:%3E42+followers:%3E1000` + * `q=tom+repos:%3E42+followers:%3E1000` * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.11/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.11/graphql/reference/queries#search)." */ get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/configcheck": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the configuration status * @description This endpoint allows you to check the status of the most recent configuration process: * - * Note that you may need to wait several seconds after you start a process before you can check its status. + * Note that you may need to wait several seconds after you start a process before you can check its status. * - * The different statuses are: + * The different statuses are: * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | + * | Status | Description | + * | ------------- | --------------------------------- | + * | `PENDING` | The job has not started yet | + * | `CONFIGURING` | The job is running | + * | `DONE` | The job has finished correctly | + * | `FAILED` | The job has finished unexpectedly | */ get: operations["enterprise-admin/get-configuration-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/configure": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a configuration process * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: */ post: operations["enterprise-admin/start-configuration-process"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/maintenance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the maintenance status * @description Check your installation's maintenance status: */ get: operations["enterprise-admin/get-maintenance-status"]; + put?: never; /** * Enable or disable maintenance mode * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get settings * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * **Note:** You cannot retrieve the management console password with the Enterprise administration API. */ get: operations["enterprise-admin/get-settings"]; /** * Set settings * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings). * - * **Notes:** + * **Notes:** * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." */ put: operations["enterprise-admin/set-settings"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/settings/authorized-keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all authorized SSH keys */ get: operations["enterprise-admin/get-all-authorized-ssh-keys"]; + put?: never; /** * Add an authorized SSH key * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). @@ -7753,239 +14124,369 @@ export interface paths { * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ delete: operations["enterprise-admin/remove-authorized-ssh-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/start": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub license * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: + * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. + * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. + * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/create-enterprise-server-license"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/upgrade-license"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#delete-a-team) endpoint. * - * To delete a team, the authenticated user must be an organization owner or team maintainer. + * To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#update-a-team) endpoint. * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. + * List all discussions on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-legacy"]; + put?: never; /** * Create a discussion (Legacy) * @deprecated * @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/enterprise-server@3.11/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. + * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. + * Get a specific discussion on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-legacy"]; + put?: never; + post?: never; /** * Delete a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. + * Delete a discussion from a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-legacy"]; + options?: never; + head?: never; /** * Update a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. + * List all comments on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-legacy"]; + put?: never; /** * Create a discussion comment (Legacy) * @deprecated * @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/enterprise-server@3.11/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. + * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. + * Get a specific comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-legacy"]; + put?: never; + post?: never; /** * Delete a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. + * Deletes a comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-legacy"]; + options?: never; + head?: never; /** * Update a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. + * Edits the body text of a discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; + put?: never; /** * Create reaction for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-legacy"]; + put?: never; /** * Create reaction for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.11/rest/teams/members#list-team-members) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. */ get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team member (Legacy) * @deprecated * @description The "Get team member" endpoint (described below) is deprecated. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/get-member-legacy"]; /** @@ -7993,46 +14494,57 @@ export interface paths { * @deprecated * @description The "Add team member" endpoint (described below) is deprecated. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated * @description The "Remove team member" endpoint (described below) is deprecated. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** @@ -8040,47 +14552,71 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * - * If 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. + * If 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. */ put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/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. + * 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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-projects) endpoint. * - * Lists the organization projects for a team. + * Lists the organization projects for a team. */ get: operations["teams/list-projects-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ get: operations["teams/check-permissions-for-project-legacy"]; /** @@ -8088,35 +14624,59 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ put: operations["teams/add-or-update-project-permissions-legacy"]; + post?: never; /** * Remove a project from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-project-from-a-team) endpoint. * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ delete: operations["teams/remove-project-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository (Legacy) * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** @@ -8124,58 +14684,108 @@ export interface paths { * @deprecated * @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/enterprise-server@3.11/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * - * 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. + * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ patch: operations["users/update-authenticated"]; + trace?: never; }; "/user/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List email addresses for the authenticated user * @description Lists all of your email addresses, and specifies which one is visible - * to the public. + * to the public. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-emails-for-authenticated-user"]; + put?: never; /** * Add an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. @@ -8186,418 +14796,827 @@ export interface paths { * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-email-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a person is followed by the authenticated user */ get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for the authenticated user * @description Lists the current user's GPG keys. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GPG key for the authenticated user * @description View extended details for a single GPG key. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You can find the permissions for the installation under the `permissions` key. + * You can find the permissions for the installation under the `permissions` key. */ get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the user access token * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * The access the user has to each repository is included in the hash under the `permissions` key. + * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user account issues assigned to the authenticated user * @description 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 - * 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/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public SSH keys for the authenticated user * @description Lists the public SSH keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a public SSH key for the authenticated user * @description View extended details for a single public SSH key. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user migrations * @description Lists all migrations a user has started. */ get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a user migration archive * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package for the authenticated user * @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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for the authenticated user * @description Restores a package owned by the authenticated user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package version for the authenticated user * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. + * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package version for the authenticated user * @description Restores a package version owned by the authenticated user. * - * You can restore a deleted package version under the following conditions: - * - 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. + * You can restore a deleted package version under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user project * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/public_emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-public-emails-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for the authenticated user * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; "/user/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for the authenticated user * @description Lists all of your social accounts. */ get: operations["users/list-social-accounts-for-authenticated-user"]; + put?: never; /** * Add social accounts for the authenticated user * @description Add one or more social accounts to the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user * @description Deletes one or more social accounts from the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-social-account-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for the authenticated user * @description Lists the SSH signing keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; + put?: never; /** * Create a SSH signing key for the authenticated user * @description Creates an SSH signing key for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ post: operations["users/create-ssh-signing-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys/{ssh_signing_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an SSH signing key for the authenticated user * @description Gets extended details for an SSH signing key. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/get-ssh-signing-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete an SSH signing key for the authenticated user * @description Deletes an SSH signing key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. @@ -8608,372 +15627,826 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams for the authenticated user * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. + * user belongs. * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.11/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.11/rest/users/emails)". */ get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. */ get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a user */ get: operations["activity/list-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of a user * @description Lists the people following the specified user. */ get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a user follows another user */ get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for a user * @description Lists public gists for the specified user: */ get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for a user * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.11/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; + put?: never; + post?: never; /** * Delete a package for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for a user * @description Restores an entire package for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; + put?: never; + post?: never; /** * Delete package version for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for a user * @description Restores a specific package version for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user projects * @description Lists projects for a user. */ get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events received by the authenticated user * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ get: operations["activity/list-received-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events received by a user */ get: operations["activity/list-received-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/site_admin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Promote a user to be a site administrator * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/promote-user-to-be-site-administrator"]; + post?: never; /** * Demote a site administrator * @description You can demote any user account except your own. */ delete: operations["enterprise-admin/demote-site-administrator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for a user * @description Lists social media accounts for a user. This endpoint is accessible by anyone. */ get: operations["users/list-social-accounts-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for a user * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. */ get: operations["users/list-ssh-signing-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * - * You can suspend any user account except your own. + * You can suspend any user account except your own. * - * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/suspend-user"]; + post?: never; /** * Unsuspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ delete: operations["enterprise-admin/unsuspend-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{base}...{head}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. * - * 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. + * 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. * - * 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. + * 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** + * **Working with large comparisons** * - * 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)." + * 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)." * - * 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. + * 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** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } - export type webhooks = Record; - export interface components { schemas: { root: { @@ -9397,11 +16870,11 @@ export interface components { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ "app-permissions": { /** @@ -9711,12 +17184,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** * Format: uri @@ -9788,7 +17259,7 @@ export interface components { /** @description The package version that resolves the vulnerability. */ first_patched_version: string | null; /** @description The functions in the package that are affected by the vulnerability. */ - vulnerable_functions: readonly string[] | null; + readonly vulnerable_functions: string[] | null; }; /** * @description The type of credit the user is receiving. @@ -9808,21 +17279,21 @@ export interface components { /** @description A GitHub Security Advisory. */ "global-advisory": { /** @description The GitHub Security Advisory ID. */ - ghsa_id: string; + readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - cve_id: string | null; + readonly cve_id: string | null; /** @description The API URL for the advisory. */ - url: string; + readonly url: string; /** * Format: uri * @description The URL for the advisory. */ - html_url: string; + readonly html_url: string; /** * Format: uri * @description The API URL for the repository advisory. */ - repository_advisory_url: string | null; + readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ summary: string; /** @description A detailed description of what the advisory entails. */ @@ -9831,7 +17302,7 @@ export interface components { * @description The type of advisory. * @enum {string} */ - type: "reviewed" | "unreviewed" | "malware"; + readonly type: "reviewed" | "unreviewed" | "malware"; /** * @description The severity of the advisory. * @enum {string} @@ -9842,8 +17313,8 @@ export interface components { * @description The URL of the advisory's source code. */ source_code_location: string | null; - identifiers: - | readonly { + readonly identifiers: + | { /** * @description The type of identifier. * @enum {string} @@ -9858,47 +17329,47 @@ export interface components { * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. */ - published_at: string; + readonly published_at: string; /** * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - updated_at: string; + readonly updated_at: string; /** * Format: date-time * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. */ - github_reviewed_at: string | null; + readonly github_reviewed_at: string | null; /** * Format: date-time * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. - * This field is only populated when the advisory is imported from the National Vulnerability Database. + * This field is only populated when the advisory is imported from the National Vulnerability Database. */ - nvd_published_at: string | null; + readonly nvd_published_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. */ - withdrawn_at: string | null; + readonly withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; /** @description The CVSS score. */ - score: number | null; + readonly score: number | null; } | null; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ - name: string; + readonly name: string; }[] | null; /** @description In GitHub Enterprise Server, this field will always be empty because the user metadata of credited users will not be available. */ - credits: - | readonly { + readonly credits: + | { user: components["schemas"]["simple-user"]; type: components["schemas"]["security-advisory-credit-types"]; }[] @@ -9971,9 +17442,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -9986,9 +17457,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -10328,12 +17799,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -10567,7 +18036,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -10600,7 +18069,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -10612,7 +18081,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -10633,69 +18102,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -10704,14 +18173,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -10735,12 +18204,10 @@ export interface components { single_file?: string; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; }; /** @@ -10771,11 +18238,9 @@ export interface components { * @example 2011-09-06T20:39:23Z */ updated_at: string; - /** - * @example [ - * "public_repo" - * ] - */ + /** @example [ + * "public_repo" + * ] */ scopes: string[]; user?: components["schemas"]["nullable-simple-user"]; }; @@ -10793,53 +18258,52 @@ export interface components { * @example https://api.github.com/codes_of_conduct/contributor_covenant */ url: string; - /** - * @example # Contributor Covenant Code of Conduct + /** @example # Contributor Covenant Code of Conduct * - * ## Our Pledge + * ## Our Pledge * - * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. * - * ## Our Standards + * ## Our Standards * - * Examples of behavior that contributes to creating a positive environment include: + * Examples of behavior that contributes to creating a positive environment include: * - * * Using welcoming and inclusive language - * * Being respectful of differing viewpoints and experiences - * * Gracefully accepting constructive criticism - * * Focusing on what is best for the community - * * Showing empathy towards other community members + * * Using welcoming and inclusive language + * * Being respectful of differing viewpoints and experiences + * * Gracefully accepting constructive criticism + * * Focusing on what is best for the community + * * Showing empathy towards other community members * - * Examples of unacceptable behavior by participants include: + * Examples of unacceptable behavior by participants include: * - * * The use of sexualized language or imagery and unwelcome sexual attention or advances - * * Trolling, insulting/derogatory comments, and personal or political attacks - * * Public or private harassment - * * Publishing others' private information, such as a physical or electronic address, without explicit permission - * * Other conduct which could reasonably be considered inappropriate in a professional setting + * * The use of sexualized language or imagery and unwelcome sexual attention or advances + * * Trolling, insulting/derogatory comments, and personal or political attacks + * * Public or private harassment + * * Publishing others' private information, such as a physical or electronic address, without explicit permission + * * Other conduct which could reasonably be considered inappropriate in a professional setting * - * ## Our Responsibilities + * ## Our Responsibilities * - * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - * to any instances of unacceptable behavior. + * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + * to any instances of unacceptable behavior. * - * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. * - * ## Scope + * ## Scope * - * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. * - * ## Enforcement + * ## Enforcement * - * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. * - * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. * - * ## Attribution + * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - */ + * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + * */ body?: string; /** Format: uri */ html_url: string | null; @@ -11039,12 +18503,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -11125,12 +18589,10 @@ export interface components { * @example 2016-07-11T22:14:10Z */ expires_at: string; - /** - * @example { - * "issues": "read", - * "deployments": "write" - * } - */ + /** @example { + * "issues": "read", + * "deployments": "write" + * } */ permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; @@ -11218,32 +18680,32 @@ export interface components { | "dismissed" | "fixed"; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string} @@ -11253,12 +18715,12 @@ export interface components { * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -11297,10 +18759,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ "code-scanning-analysis-analysis-key": string; @@ -11338,10 +18798,8 @@ export interface components { }; location?: components["schemas"]["code-scanning-alert-location"]; html_url?: string; - /** - * @description Classifications that have been applied to the file that triggered the alert. - * For example identifying it as documentation, or a generated file. - */ + /** @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. */ classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; /** @@ -11607,25 +19065,25 @@ export interface components { "enterprise-security-analysis-settings": { /** * @description Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to - * this enterprise. + * this enterprise. * @example false */ advanced_security_enabled_for_new_repositories: boolean; /** * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ dependabot_alerts_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ secret_scanning_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this enterprise. + * transferred to this enterprise. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories: boolean; @@ -11636,15 +19094,15 @@ export interface components { secret_scanning_push_protection_custom_link?: string | null; }; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -11659,7 +19117,7 @@ export interface components { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -11669,7 +19127,7 @@ export interface components { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -11683,14 +19141,14 @@ export interface components { readonly vector_string: string | null; }; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -11700,7 +19158,7 @@ export interface components { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -11727,7 +19185,7 @@ export interface components { * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -11735,10 +19193,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -11776,7 +19234,7 @@ export interface components { * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "nullable-alert-updated-at": string | null; + "nullable-alert-updated-at": string | null; /** * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} @@ -11813,10 +19271,8 @@ export interface components { resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -11982,9 +19438,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -11997,9 +19453,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -12098,14 +19554,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -12115,9 +19570,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -12254,11 +19708,9 @@ export interface components { current_user_actor_url?: string; /** @example https://github.com/octocat-org */ current_user_organization_url?: string; - /** - * @example [ - * "https://github.com/organizations/github/octocat.private.atom?token=abc123" - * ] - */ + /** @example [ + * "https://github.com/organizations/github/octocat.private.atom?token=abc123" + * ] */ current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ security_advisories_url?: string; @@ -12305,13 +19757,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12452,13 +19906,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12484,15 +19940,17 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; + [key: string]: + | ({ + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + } | null) + | undefined; }; public?: boolean; created_at?: string; @@ -12567,25 +20025,24 @@ export interface components { "gitignore-template": { /** @example C */ name: string; - /** - * @example # Object files - * *.o + /** @example # Object files + * *.o * - * # Libraries - * *.lib - * *.a + * # Libraries + * *.lib + * *.a * - * # Shared objects (inc. Windows DLLs) - * *.dll - * *.so - * *.so.* - * *.dylib + * # Shared objects (inc. Windows DLLs) + * *.dll + * *.so + * *.so.* + * *.dylib * - * # Executables - * *.exe - * *.out - * *.app - */ + * # Executables + * *.exe + * *.out + * *.app + * */ source: string; }; /** @@ -12636,53 +20093,46 @@ export interface components { description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ implementation: string; - /** - * @example [ - * "commercial-use", - * "modifications", - * "distribution", - * "sublicense", - * "private-use" - * ] - */ + /** @example [ + * "commercial-use", + * "modifications", + * "distribution", + * "sublicense", + * "private-use" + * ] */ permissions: string[]; - /** - * @example [ - * "include-copyright" - * ] - */ + /** @example [ + * "include-copyright" + * ] */ conditions: string[]; - /** - * @example [ - * "no-liability" - * ] - */ + /** @example [ + * "no-liability" + * ] */ limitations: string[]; - /** - * @example + /** @example * - * The MIT License (MIT) + * The MIT License (MIT) * - * Copyright (c) [year] [fullname] + * Copyright (c) [year] [fullname] * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * */ body: string; /** @example true */ featured: boolean; @@ -12800,17 +20250,13 @@ export interface components { "api-overview": { /** @example true */ verifiable_password_authentication: boolean; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ dependabot?: string[]; domains?: { website?: string[]; @@ -13255,47 +20701,47 @@ export interface components { /** * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; @@ -13380,12 +20826,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -13851,15 +21297,15 @@ export interface components { /** * @description An array of teams linked to this group * @example [ - * { - * "team_id": 1, - * "team_name": "team-test" - * }, - * { - * "team_id": 2, - * "team_name": "team-test2" - * } - * ] + * { + * "team_id": 1, + * "team_name": "team-test" + * }, + * { + * "team_id": 2, + * "team_name": "team-test2" + * } + * ] */ teams: { /** @@ -13876,19 +21322,19 @@ export interface components { /** * @description An array of external members linked to this group * @example [ - * { - * "member_id": 1, - * "member_login": "mona-lisa_eocsaxrs", - * "member_name": "Mona Lisa", - * "member_email": "mona_lisa@github.com" - * }, - * { - * "member_id": 2, - * "member_login": "octo-lisa_eocsaxrs", - * "member_name": "Octo Lisa", - * "member_email": "octo_lisa@github.com" - * } - * ] + * { + * "member_id": 1, + * "member_login": "mona-lisa_eocsaxrs", + * "member_name": "Mona Lisa", + * "member_email": "mona_lisa@github.com" + * }, + * { + * "member_id": 2, + * "member_login": "octo-lisa_eocsaxrs", + * "member_name": "Octo Lisa", + * "member_email": "octo_lisa@github.com" + * } + * ] */ members: { /** @@ -13921,17 +21367,17 @@ export interface components { /** * @description An array of external groups available to be mapped to a team * @example [ - * { - * "group_id": 1, - * "group_name": "group-azuread-test", - * "updated_at": "2021-01-03 22:27:15:000 -700" - * }, - * { - * "group_id": 2, - * "group_name": "group-azuread-test2", - * "updated_at": "2021-06-03 22:27:15:000 -700" - * } - * ] + * { + * "group_id": 1, + * "group_name": "group-azuread-test", + * "updated_at": "2021-01-03 22:27:15:000 -700" + * }, + * { + * "group_id": 2, + * "group_name": "group-azuread-test2", + * "updated_at": "2021-06-03 22:27:15:000 -700" + * } + * ] */ groups?: { /** @@ -13975,12 +21421,10 @@ export interface components { deliveries_url?: string; /** @example web */ name: string; - /** - * @example [ - * "push", - * "pull_request" - * ] - */ + /** @example [ + * "push", + * "pull_request" + * ] */ events: string[]; /** @example true */ active: boolean; @@ -14164,13 +21608,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the request for access was created. */ @@ -14200,13 +21644,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -14493,7 +21937,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -14526,7 +21970,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -14538,7 +21982,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -14559,69 +22003,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -14630,14 +22074,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -14844,14 +22288,12 @@ export interface components { open_issues_count: number; /** @example true */ is_template?: boolean; - /** - * @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] - */ + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ topics?: string[]; /** @example true */ has_issues: boolean; @@ -14913,8 +22355,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @example PR_TITLE * @enum {string} */ @@ -14922,9 +22364,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -14932,8 +22374,8 @@ export interface components { /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @example PR_TITLE * @enum {string} */ @@ -14941,9 +22383,9 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -14968,7 +22410,7 @@ export interface components { * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; + anonymous_access_enabled: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; }; @@ -15047,6 +22489,7 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & @@ -15338,7 +22781,7 @@ export interface components { bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** * @description The bypass type of the user making the API request for this ruleset. This field is only returned when - * querying the repository-level endpoint. + * querying the repository-level endpoint. * @enum {string} */ current_user_can_bypass?: "always" | "pull_requests_only" | "never"; @@ -16143,7 +23586,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -16181,7 +23624,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -16202,44 +23645,44 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - allow_forking?: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -16584,10 +24027,10 @@ export interface components { /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ - * "self-hosted", - * "foo", - * "bar" - * ] + * "self-hosted", + * "foo", + * "bar" + * ] */ labels: string[]; /** @@ -16681,9 +24124,9 @@ export interface components { "actions-workflow-access-to-repository": { /** * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the - * repository. + * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. * @enum {string} */ access_level: "none" | "user" | "organization" | "enterprise"; @@ -17055,14 +24498,11 @@ export interface components { * @example deploy */ task: string; - payload: OneOf< - [ - { + payload: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** @example staging */ original_environment?: string; /** @@ -17305,7 +24745,7 @@ export interface components { * @default false * @example true */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; }; /** * Branch Restriction Policy @@ -17452,12 +24892,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -17645,11 +25085,9 @@ export interface components { url: string; /** @example true */ strict: boolean; - /** - * @example [ - * "continuous-integration/travis-ci" - * ] - */ + /** @example [ + * "continuous-integration/travis-ci" + * ] */ contexts: string[]; checks: { /** @example continuous-integration/travis-ci */ @@ -17680,7 +25118,7 @@ export interface components { * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; dismissal_restrictions?: { /** Format: uri */ url: string; @@ -17731,12 +25169,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -18114,12 +25552,12 @@ export interface components { * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; + "code-scanning-analysis-url": string; "code-scanning-analysis": { ref: components["schemas"]["code-scanning-ref"]; commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; @@ -18154,12 +25592,12 @@ export interface components { * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + readonly next_analysis_url: string | null; /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; + readonly confirm_delete_url: string | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { @@ -18223,10 +25661,8 @@ export interface components { )[]; [key: string]: unknown; }; - /** - * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. - * You should not rely on this always being an actions workflow run object. - */ + /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. + * You should not rely on this always being an actions workflow run object. */ "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ run_id?: number; @@ -18235,7 +25671,7 @@ export interface components { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -18247,7 +25683,7 @@ export interface components { * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; + readonly url?: string; }; "code-scanning-sarifs-status": { /** @@ -18259,9 +25695,9 @@ export interface components { * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** * CODEOWNERS errors @@ -18298,8 +25734,8 @@ export interface components { * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: * - * * user - * ^ + * * user + * ^ */ message: string; /** @@ -19034,10 +26470,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -19177,19 +26613,19 @@ export interface components { name?: string; /** * @description The version of the package. If the package does not have an exact version specified, - * a version range is given. + * a version range is given. * @example 1.0.0 */ versionInfo?: string; /** * @description The location where the package can be downloaded, - * or NOASSERTION if this has not been determined. + * or NOASSERTION if this has not been determined. * @example NOASSERTION */ downloadLocation?: string; /** * @description Whether the package's file content has been subjected to - * analysis during the creation of the SPDX document. + * analysis during the creation of the SPDX document. * @example false */ filesAnalyzed?: boolean; @@ -19200,7 +26636,7 @@ export interface components { licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information - * was not available when the SPDX document was created. + * was not available when the SPDX document was created. * @example NOASSERTION */ licenseDeclared?: string; @@ -19234,7 +26670,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: (string | number | boolean) | null; + [key: string]: ((string | number | boolean) | null) | undefined; }; dependency: { /** @@ -19277,7 +26713,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"]; + [key: string]: components["schemas"]["dependency"] | undefined; }; }; /** @@ -19335,7 +26771,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"]; + [key: string]: components["schemas"]["manifest"] | undefined; }; /** * Format: date-time @@ -19383,7 +26819,7 @@ export interface components { * @default * @example production */ - environment?: string; + environment: string; /** * Format: uri * @description Deprecated: the URL to associate with this status. @@ -19417,14 +26853,14 @@ export interface components { * @default * @example https://staging.example.com/ */ - environment_url?: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - log_url?: string; + log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** @@ -19542,8 +26978,8 @@ export interface components { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -19553,8 +26989,8 @@ export interface components { /** * @description The name pattern that branches must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -19784,43 +27220,43 @@ export interface components { /** * @description Objects specifying a tree structure * @example [ - * { - * "path": "file.rb", - * "mode": "100644", - * "type": "blob", - * "size": 30, - * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" + * { + * "path": "file.rb", + * "mode": "100644", + * "type": "blob", + * "size": 30, + * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", + * "properties": { + * "path": { + * "type": "string" + * }, + * "mode": { + * "type": "string" + * }, + * "type": { + * "type": "string" + * }, + * "size": { + * "type": "integer" + * }, + * "sha": { + * "type": "string" + * }, + * "url": { + * "type": "string" + * } + * }, + * "required": [ + * "path", + * "mode", + * "type", + * "sha", + * "url", + * "size" + * ] * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" * ] - * } - * ] */ tree: { /** @example test/file.rb */ @@ -19867,9 +27303,9 @@ export interface components { /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ - * "push", - * "pull_request" - * ] + * "push", + * "pull_request" + * ] */ events: string[]; config: components["schemas"]["webhook-config"]; @@ -19993,14 +27429,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -20010,9 +27445,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -20814,7 +28248,7 @@ export interface components { * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -20830,7 +28264,7 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} @@ -20956,7 +28390,7 @@ export interface components { * @description Language */ language: { - [key: string]: number; + [key: string]: number | undefined; }; /** * License Content @@ -21096,9 +28530,9 @@ export interface components { /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ - * "example.com", - * "www.example.com" - * ] + * "example.com", + * "www.example.com" + * ] */ domains: string[]; /** Format: date */ @@ -21879,13 +29313,13 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -22075,10 +29509,8 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -22274,17 +29706,15 @@ export interface components { * @description Commit Activity */ "commit-activity": { - /** - * @example [ - * 0, - * 3, - * 26, - * 20, - * 39, - * 1, - * 0 - * ] - */ + /** @example [ + * 0, + * 3, + * 26, + * 20, + * 39, + * 1, + * 0 + * ] */ days: number[]; /** @example 89 */ total: number; @@ -22299,16 +29729,14 @@ export interface components { author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ total: number; - /** - * @example [ - * { - * "w": "1367712000", - * "a": 6898, - * "d": 77, - * "c": 10 - * } - * ] - */ + /** @example [ + * { + * "w": "1367712000", + * "a": 6898, + * "d": 77, + * "c": 10 + * } + * ] */ weeks: { w?: number; a?: number; @@ -22401,8 +29829,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: ( | "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -22463,17 +29891,17 @@ export interface components { /** * @description The security group members. * @example [ - * { - * "value": "879db59-3bdf-4490-ad68-ab880a2694745", - * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - * "displayName": "User 1" - * }, - * { - * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - * "displayName": "User 2" - * } - * ] + * { + * "value": "879db59-3bdf-4490-ad68-ab880a2694745", + * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + * "displayName": "User 1" + * }, + * { + * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + * "displayName": "User 2" + * } + * ] */ members?: { value?: string; @@ -22486,8 +29914,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -22512,8 +29940,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:Group"[]; /** @@ -22621,8 +30049,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -22667,8 +30095,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -22733,8 +30161,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -22792,12 +30220,10 @@ export interface components { language?: string | null; /** Format: date-time */ last_modified_at?: string; - /** - * @example [ - * "73..77", - * "77..78" - * ] - */ + /** @example [ + * "73..77", + * "77..78" + * ] */ line_numbers?: string[]; text_matches?: components["schemas"]["search-result-text-matches"]; }; @@ -23462,36 +30888,32 @@ export interface components { key_id: string; /** @example xsBNBFayYZ... */ public_key: string; - /** - * @example [ - * { - * "email": "octocat@users.noreply.github.com", - * "verified": true - * } - * ] - */ + /** @example [ + * { + * "email": "octocat@users.noreply.github.com", + * "verified": true + * } + * ] */ emails: { email?: string; verified?: boolean; }[]; - /** - * @example [ - * { - * "id": 4, - * "primary_key_id": 3, - * "key_id": "4A595D4C72EE49C7", - * "public_key": "zsBNBFayYZ...", - * "emails": [], - * "can_sign": false, - * "can_encrypt_comms": true, - * "can_encrypt_storage": true, - * "can_certify": false, - * "created_at": "2016-03-24T11:31:04-06:00", - * "expires_at": null, - * "revoked": false - * } - * ] - */ + /** @example [ + * { + * "id": 4, + * "primary_key_id": 3, + * "key_id": "4A595D4C72EE49C7", + * "public_key": "zsBNBFayYZ...", + * "emails": [], + * "can_sign": false, + * "can_encrypt_comms": true, + * "can_encrypt_storage": true, + * "can_certify": false, + * "created_at": "2016-03-24T11:31:04-06:00", + * "expires_at": null, + * "revoked": false + * } + * ] */ subkeys: { id?: number; primary_key_id?: number; @@ -23593,8 +31015,9 @@ export interface components { /** * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured - * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts)." + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.11/admin/overview/about-enterprise-accounts)." + * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -23642,8 +31065,8 @@ export interface components { /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured - * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * for and sent to a GitHub App. For more information, + * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -23660,7 +31083,7 @@ export interface components { /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an - * organization, or when the event occurs from activity in a repository owned by an organization. + * organization, or when the event occurs from activity in a repository owned by an organization. */ "organization-simple-webhooks": { /** @example github */ @@ -23700,7 +31123,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "repository-webhooks": { /** @@ -23902,7 +31325,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -23934,7 +31357,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -23946,7 +31369,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -23967,7 +31390,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -24077,34 +31500,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -24118,62 +31541,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -24182,14 +31605,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -24769,8 +32192,8 @@ export interface components { repository_url: string; /** * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. * @enum {string} */ state: "open" | "closed" | "locked" | "converting" | "transferring"; @@ -26157,7 +33580,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** @@ -26359,7 +33782,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -26391,7 +33814,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -26403,7 +33826,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -26424,7 +33847,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -26534,34 +33957,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -26575,62 +33998,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -26639,14 +34062,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -26788,37 +34211,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ permissions_added: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @@ -27077,41 +34500,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -27119,7 +34542,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; /** Pull Request */ webhooks_pull_request_5: { @@ -27324,24 +34747,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -27377,7 +34800,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -27461,17 +34884,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -27538,7 +34961,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -27546,17 +34969,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -27588,7 +35011,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -27664,24 +35087,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -27717,7 +35140,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -27801,17 +35224,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -27878,7 +35301,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -27886,17 +35309,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -27928,7 +35351,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -28118,9 +35541,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -28155,8 +35577,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -28206,9 +35628,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -30786,7 +38207,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: Record | null; + dismissed_by: Record; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -31818,7 +39239,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -32137,7 +39558,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -32495,7 +39916,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -32825,7 +40246,7 @@ export interface components { id: number; node_id: string; original_environment: string; - payload: string | Record | null; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -33833,24 +41254,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -33890,7 +41311,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -34029,7 +41450,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -34112,7 +41533,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: Record | null; + license?: Record; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -34972,7 +42393,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34999,10 +42420,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -35561,7 +42982,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -35588,10 +43009,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -36153,7 +43574,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -36180,10 +43601,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -36725,8 +44146,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -36736,13 +44157,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -40169,24 +47590,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -40222,7 +47643,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -40363,7 +47784,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -41853,24 +49274,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -41906,7 +49327,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -42050,7 +49471,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -42665,12 +50086,10 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { - /** - * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - * assigned to the collaborator, use the `role_name` field instead, which will provide the full - * role name, including custom roles. - */ + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; @@ -43104,11 +50523,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string; + [key: string]: string | undefined; }; repo?: string; dependencies?: { - [key: string]: string; + [key: string]: string | undefined; }[]; commit_oid?: string; }; @@ -43208,8 +50627,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -43234,19 +50653,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: Record | null; - bugs?: Record | null; + author?: Record; + bugs?: Record; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: Record | null; + dist?: Record; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: Record | null; + repository?: Record; scripts?: Record; id?: string; node_version?: string; @@ -43259,7 +50678,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: Record | null; + directories?: Record; os?: string[]; cpu?: string[]; readme?: string; @@ -43273,19 +50692,16 @@ export interface components { | { id?: number | string; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -44162,22 +51578,19 @@ export interface components { "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; - changes?: OneOf< - [ - { + changes?: + | { field_value: { field_node_id?: string; field_type?: string; }; - }, - { + } + | { body: { from?: string | null; to?: string | null; }; - }, - ] - >; + }; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; @@ -44437,24 +51850,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -44490,7 +51903,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -44574,17 +51987,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -44651,7 +52064,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -44659,9 +52072,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -44671,8 +52084,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -44704,7 +52117,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -44780,24 +52193,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -44833,7 +52246,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -44917,17 +52330,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -44994,7 +52407,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -45002,9 +52415,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -45014,8 +52427,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -45047,7 +52460,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45237,9 +52650,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45274,8 +52686,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -45325,9 +52737,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -45649,24 +53060,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -45702,7 +53113,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -45786,17 +53197,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -45863,7 +53274,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -45871,9 +53282,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -45883,8 +53294,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -45916,7 +53327,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45992,24 +53403,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46045,7 +53456,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46129,17 +53540,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46206,7 +53617,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46214,9 +53625,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46226,8 +53637,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46259,7 +53670,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46449,9 +53860,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -46486,8 +53896,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -46537,9 +53947,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -46862,24 +54271,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46915,7 +54324,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46999,17 +54408,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47076,7 +54485,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47084,9 +54493,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47096,8 +54505,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47129,7 +54538,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -47205,24 +54614,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47258,7 +54667,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47342,17 +54751,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47419,7 +54828,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47427,9 +54836,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47439,8 +54848,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47472,7 +54881,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -47662,9 +55071,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47699,8 +55107,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -47750,9 +55158,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -48143,24 +55550,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48196,7 +55603,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48280,17 +55687,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48357,7 +55764,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48365,9 +55772,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48377,8 +55784,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48410,7 +55817,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48486,24 +55893,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48539,7 +55946,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48623,17 +56030,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48700,7 +56107,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48708,9 +56115,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48720,8 +56127,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48753,7 +56160,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48943,9 +56350,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48980,8 +56386,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -49031,9 +56437,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -49355,24 +56760,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -49408,7 +56813,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49492,17 +56897,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49569,7 +56974,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49577,9 +56982,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -49589,8 +56994,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49622,7 +57027,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -49698,24 +57103,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -49751,7 +57156,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49835,17 +57240,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49912,7 +57317,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49920,9 +57325,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -49932,8 +57337,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49965,7 +57370,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50155,9 +57560,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50192,8 +57596,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -50243,9 +57647,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -50765,24 +58168,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50818,7 +58221,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50902,17 +58305,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50979,7 +58382,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50987,9 +58390,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50999,8 +58402,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51032,7 +58435,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51101,24 +58504,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51154,7 +58557,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51203,7 +58606,7 @@ export interface components { * @description Whether discussions are enabled. * @default false */ - has_discussions?: boolean; + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -51238,17 +58641,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51315,7 +58718,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51323,9 +58726,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51335,8 +58738,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51368,7 +58771,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51513,9 +58916,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51550,8 +58952,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -51601,9 +59003,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -51917,24 +59318,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51970,7 +59371,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52054,17 +59455,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52131,7 +59532,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52139,9 +59540,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52151,8 +59552,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52184,7 +59585,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52253,24 +59654,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52306,7 +59707,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52390,17 +59791,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52467,7 +59868,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52475,9 +59876,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52487,8 +59888,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52520,7 +59921,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52665,9 +60066,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52702,8 +60102,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -52753,9 +60153,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -53070,24 +60469,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53123,7 +60522,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53207,17 +60606,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53284,7 +60683,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53292,9 +60691,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53304,8 +60703,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53337,7 +60736,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53406,24 +60805,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53459,7 +60858,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53543,17 +60942,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53620,7 +61019,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53628,9 +61027,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53640,8 +61039,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53673,7 +61072,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53818,9 +61217,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53855,8 +61253,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -53906,9 +61304,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -54222,24 +61619,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54275,7 +61672,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54359,17 +61756,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -54436,7 +61833,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54444,9 +61841,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -54456,8 +61853,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -54489,7 +61886,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54558,24 +61955,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54611,7 +62008,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54695,17 +62092,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -54772,7 +62169,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54780,9 +62177,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -54792,8 +62189,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -54825,7 +62222,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54970,9 +62367,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55007,8 +62403,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -55058,9 +62454,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -55461,24 +62856,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55514,7 +62909,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55653,7 +63048,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55748,24 +63143,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55801,7 +63196,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55940,7 +63335,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56111,9 +63506,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56148,8 +63542,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -56199,9 +63593,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -56308,9 +63701,8 @@ export interface components { sender: components["schemas"]["simple-user-webhooks"]; }; /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": OneOf< - [ - { + "webhook-pull-request-review-request-removed": + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -56521,24 +63913,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56574,7 +63966,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56658,17 +64050,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56735,7 +64127,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56781,7 +64173,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56857,24 +64249,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56910,7 +64302,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56994,17 +64386,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57071,7 +64463,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57079,9 +64471,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57091,8 +64483,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57124,7 +64516,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57314,9 +64706,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57351,8 +64742,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -57402,9 +64793,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -57551,8 +64941,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -57763,24 +65153,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57816,7 +65206,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57900,17 +65290,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57977,7 +65367,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57985,9 +65375,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57997,8 +65387,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58030,7 +65420,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58106,24 +65496,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58159,7 +65549,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58243,17 +65633,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58320,7 +65710,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58328,9 +65718,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58340,8 +65730,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58373,7 +65763,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58563,9 +65953,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -58600,8 +65989,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -58651,9 +66040,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -58818,13 +66206,10 @@ export interface components { url: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request review_requested event */ - "webhook-pull-request-review-requested": OneOf< - [ - { + "webhook-pull-request-review-requested": + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -59035,24 +66420,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59088,7 +66473,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59172,17 +66557,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59249,7 +66634,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59257,9 +66642,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59269,8 +66654,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -59302,7 +66687,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59378,24 +66763,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59431,7 +66816,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59515,17 +66900,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59592,7 +66977,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59600,9 +66985,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59612,8 +66997,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -59645,7 +67030,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59835,9 +67220,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -59872,8 +67256,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -59923,9 +67307,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -60072,8 +67455,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -60284,24 +67667,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60337,7 +67720,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60421,17 +67804,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60498,7 +67881,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60506,9 +67889,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60518,8 +67901,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60551,7 +67934,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60627,24 +68010,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60680,7 +68063,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60764,17 +68147,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60841,7 +68224,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60849,9 +68232,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60861,8 +68244,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60894,7 +68277,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61084,9 +68467,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -61121,8 +68503,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -61172,9 +68554,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -61339,9 +68720,7 @@ export interface components { url?: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { /** @enum {string} */ @@ -61551,24 +68930,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61604,7 +68983,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61688,17 +69067,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -61765,7 +69144,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61773,9 +69152,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -61785,8 +69164,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -61818,7 +69197,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61887,24 +69266,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61940,7 +69319,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62024,17 +69403,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -62101,7 +69480,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62109,9 +69488,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -62121,8 +69500,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -62154,7 +69533,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -62299,9 +69678,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -62336,8 +69714,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -62387,9 +69765,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -62704,24 +70081,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62757,7 +70134,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62901,7 +70278,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62998,24 +70375,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63051,7 +70428,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63195,7 +70572,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63368,9 +70745,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -63405,8 +70781,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -63456,9 +70832,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -63924,24 +71299,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63977,7 +71352,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64121,7 +71496,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64218,24 +71593,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64271,7 +71646,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64415,7 +71790,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64588,9 +71963,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -64625,8 +71999,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -64676,9 +72050,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -65148,24 +72521,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65201,7 +72574,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65285,17 +72658,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65362,7 +72735,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65370,9 +72743,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65382,8 +72755,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65415,7 +72788,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65491,24 +72864,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65544,7 +72917,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65698,7 +73071,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65706,9 +73079,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65718,8 +73091,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65751,7 +73124,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65941,9 +73314,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -65978,8 +73350,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -66029,9 +73401,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -66354,24 +73725,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66407,7 +73778,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66491,17 +73862,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66568,7 +73939,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66576,9 +73947,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66588,8 +73959,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66621,7 +73992,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66697,24 +74068,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66750,7 +74121,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66834,17 +74205,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66911,7 +74282,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66919,9 +74290,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66931,8 +74302,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66964,7 +74335,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67154,9 +74525,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -67191,8 +74561,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -67242,9 +74612,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -67567,24 +74936,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67620,7 +74989,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67704,17 +75073,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -67781,7 +75150,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67789,9 +75158,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67801,8 +75170,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -67834,7 +75203,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67910,24 +75279,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67963,7 +75332,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68117,7 +75486,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68125,9 +75494,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -68137,8 +75506,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -68170,7 +75539,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68360,9 +75729,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -68397,8 +75765,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -68448,9 +75816,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -68772,24 +76139,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68825,7 +76192,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68909,17 +76276,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -68986,7 +76353,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68994,9 +76361,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -69006,8 +76373,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -69039,7 +76406,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -69115,24 +76482,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69168,7 +76535,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -69252,17 +76619,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -69329,7 +76696,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69337,9 +76704,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -69349,8 +76716,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -69382,7 +76749,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -69572,9 +76939,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -69609,8 +76975,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -69660,9 +77026,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -69917,24 +77282,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69970,7 +77335,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70114,7 +77479,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -70211,8 +77576,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -70236,19 +77601,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: string | Record | null; - bugs?: string | Record | null; + author?: (string | Record) | null; + bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: string | Record | null; + dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: string | Record | null; + repository?: (string | Record) | null; scripts?: Record; id?: string; node_version?: string; @@ -70261,7 +77626,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: string | Record | null; + directories?: (string | Record) | null; os?: string[]; cpu?: string[]; readme?: string; @@ -70273,21 +77638,18 @@ export interface components { } | null; nuget_metadata?: | { - id?: string | Record | number | null; + id?: (string | Record | number) | null; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -70484,7 +77846,7 @@ export interface components { updated_at: string; version: string; }; - registry: Record | null; + registry: Record; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -71643,24 +79005,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71696,7 +79058,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71835,7 +79197,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71888,24 +79250,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71941,7 +79303,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72080,7 +79442,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -72133,24 +79495,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -72186,7 +79548,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72325,7 +79687,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -72409,24 +79771,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -72462,7 +79824,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72601,7 +79963,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -72654,24 +80016,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -72707,7 +80069,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72846,7 +80208,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -73026,7 +80388,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: (Record | null)[]; + steps?: Record[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -74647,18 +82009,27 @@ export interface components { responses: { /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Resource not found */ not_found: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad Request */ bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -74666,40 +82037,61 @@ export interface components { }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ accepted: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description Not modified */ not_modified: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Requires authentication */ requires_authentication: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Gone */ gone: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response */ actions_runner_jitconfig: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { runner: components["schemas"]["runner"]; @@ -74710,6 +82102,9 @@ export interface components { }; /** @description Response */ actions_runner_labels: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -74719,6 +82114,9 @@ export interface components { }; /** @description Response */ actions_runner_labels_readonly: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -74728,6 +82126,9 @@ export interface components { }; /** @description Service unavailable */ service_unavailable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -74738,12 +82139,18 @@ export interface components { }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden Gist */ forbidden_gist: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { block?: { @@ -74758,66 +82165,102 @@ export interface components { }; /** @description Moved permanently */ moved_permanently: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Conflict */ conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal Error */ internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description A header with no content is returned. */ no_content: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Temporary Redirect */ temporary_redirect: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if there is already a validation run in progress with a different default setup configuration */ code_scanning_conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Found */ found: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ dependency_review_forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unacceptable */ unacceptable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad request */ scim_bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -74825,14 +82268,23 @@ export interface components { }; /** @description Authorization failure */ authorization_failure: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Permission denied */ permission_denied: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Too many requests */ scim_too_many_requests: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -74840,6 +82292,9 @@ export interface components { }; /** @description Internal server error */ scim_internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -74847,18 +82302,21 @@ export interface components { }; /** @description Duplicate record detected */ duplicate_record_detected: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; parameters: { /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "per-page"?: number; + "per-page": number; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: number; + page: number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction?: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The unique identifier of the team. */ @@ -74874,16 +82332,16 @@ export interface components { /** @description The unique identifier of the token. */ "token-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; + "pagination-before": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; + "pagination-after": string; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: string; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: string; + cursor: string; "delivery-id": number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: string; + since: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The unique identifier of the grant. */ @@ -74900,7 +82358,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization"?: string; + "visible-to-organization": string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -74908,132 +82366,112 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase"?: string; - /** - * @description The event types to include: + "audit-log-enterprise-phrase": string; + /** @description The event types to include: * - * - `web` - returns web (non-Git) events. - * - `git` - returns Git events. - * - `all` - returns both web and Git events. + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. * - * The default is `web`. - */ - "audit-log-include"?: "web" | "git" | "all"; + * The default is `web`. */ + "audit-log-include": "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after"?: string; + "audit-log-after": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before"?: string; - /** - * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + "audit-log-before": string; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * - * The default is `desc`. - */ - "audit-log-order"?: "desc" | "asc"; + * The default is `desc`. */ + "audit-log-order": "desc" | "asc"; /** @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. */ - "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @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. */ - "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - "dependabot-alert-comma-separated-states"?: string; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ + "dependabot-alert-comma-separated-states": string; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * - * Can be: `low`, `medium`, `high`, `critical` - */ - "dependabot-alert-comma-separated-severities"?: string; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * Can be: `low`, `medium`, `high`, `critical` */ + "dependabot-alert-comma-separated-severities": string; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - "dependabot-alert-comma-separated-ecosystems"?: string; + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ + "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages"?: string; + "dependabot-alert-comma-separated-packages": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope"?: "development" | "runtime"; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - */ - "dependabot-alert-sort"?: "created" | "updated"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first"?: number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last"?: number; + "dependabot-alert-scope": "development" | "runtime"; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ + "dependabot-alert-sort": "created" | "updated"; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ + "pagination-first": number; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ + "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ - "secret-scanning-alert-secret-type"?: string; + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution"?: string; + "secret-scanning-alert-resolution": string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort"?: "created" | "updated"; + "secret-scanning-alert-sort": "created" | "updated"; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" | "dependabot_alerts" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the enterprise. - * `disable_all` means to disable the specified security feature for all repositories in the enterprise. - */ + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ "enterprise-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: string; + labels: string; /** @description The UUID which identifies a node. */ - uuid?: string; + uuid: string; /** @description The cluster roles from the cluster configuration file. */ - "cluster-roles"?: string; + "cluster-roles": string; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all?: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: string; + before: string; /** @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/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org"?: number; + "since-org": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository"?: string; + "visible-to-repository": string; /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "variables-per-page"?: number; + "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase"?: string; + "audit-log-phrase": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The unique identifier of the group. */ @@ -75042,13 +82480,11 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - */ - "package-visibility"?: "public" | "private" | "internal"; + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ + "package-visibility": "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ "package-type": | "npm" @@ -75062,23 +82498,23 @@ export interface components { /** @description Unique identifier of the package version. */ "package-version-id": number; /** @description The property by which to sort the results. */ - "personal-access-token-sort"?: "created_at"; + "personal-access-token-sort": "created_at"; /** @description A list of owner usernames to use to filter the results. */ - "personal-access-token-owner"?: string[]; + "personal-access-token-owner": string[]; /** @description The name of the repository to use to filter the results. */ - "personal-access-token-repository"?: string; + "personal-access-token-repository": string; /** @description The permission to use to filter the results. */ - "personal-access-token-permission"?: string; + "personal-access-token-permission": string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-before"?: string; + "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-after"?: string; + "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo"?: string; + "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo"?: string; + "secret-scanning-pagination-after-org-repo": string; /** @description The slug of the team name. */ "team-slug": string; /** @description The number that identifies the discussion. */ @@ -75098,27 +82534,25 @@ export interface components { | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the card. */ "card-id": number; /** @description The unique identifier of the column. */ "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - "artifact-name"?: string; + "artifact-name": string; /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full"?: string; + "actions-cache-git-ref-full": string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key"?: string; + "actions-cache-key": string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort"?: + "actions-cache-list-sort": | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -75129,13 +82563,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch"?: string; + "workflow-run-branch": string; /** @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/enterprise-server@3.11/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: string; + event: string; /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ - "workflow-run-status"?: + "workflow-run-status": | "completed" | "action_required" | "cancelled" @@ -75151,13 +82585,13 @@ export interface components { | "waiting" | "pending"; /** @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/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests"?: boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id"?: number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha"?: string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -75173,11 +82607,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name"?: string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - status?: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @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`. */ - "git-ref"?: components["schemas"]["code-scanning-ref"]; + "git-ref": components["schemas"]["code-scanning-ref"]; /** @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. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -75185,16 +82619,14 @@ export interface components { /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ "commit-ref": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests"?: string; - /** - * @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. - */ + "dependabot-alert-comma-separated-manifests": string; + /** @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. */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path"?: string; + "manifest-path": string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ @@ -75211,7 +82643,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort?: "created" | "updated"; + sort: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -75229,31 +82661,31 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo"?: number; + "since-repo": number; /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ - "excluded-attributes"?: string; + "excluded-attributes": string; /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ - "start-index"?: number; + "start-index": number; /** @description Used for pagination: the number of results to return per page. */ - count?: number; + count: number; /** @description A unique identifier of the SCIM group. */ "scim-group-id": string; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: "desc" | "asc"; + order: "desc" | "asc"; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "since-repo-date"?: string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date"?: string; + "before-repo-date": string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred"?: "created" | "updated"; + "sort-starred": "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user"?: number; + "since-user": number; }; requestBodies: never; headers: { @@ -75274,39 +82706,47 @@ export interface components { }; pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - /** - * GitHub API Root - * @description Get Hypermedia links to resources accessible in GitHub's REST API - */ "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["root"]; }; }; }; }; - /** List global webhooks */ "enterprise-admin/list-global-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["global-hook"][]; @@ -75314,8 +82754,13 @@ export interface operations { }; }; }; - /** Create a global webhook */ "enterprise-admin/create-global-webhook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -75345,51 +82790,68 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Get a global webhook */ "enterprise-admin/get-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Delete a global webhook */ "enterprise-admin/delete-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a global webhook - * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. - */ "enterprise-admin/update-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75418,46 +82880,60 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook-2"]; }; }; }; }; - /** - * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the webhook. - */ "enterprise-admin/ping-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List public keys */ "enterprise-admin/list-public-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "accessed"; /** @description Only show public keys accessed after the given time. */ since?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["public-key-full"][]; @@ -75465,29 +82941,36 @@ export interface operations { }; }; }; - /** Delete a public key */ "enterprise-admin/delete-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_ids: components["parameters"]["key-ids"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. - */ "enterprise-admin/update-ldap-mapping-for-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75500,25 +82983,32 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ldap-mapping-team"]; }; }; }; }; - /** - * Sync LDAP mapping for a team - * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. - */ "enterprise-admin/sync-ldap-mapping-for-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { status?: string; @@ -75527,12 +83017,15 @@ export interface operations { }; }; }; - /** Update LDAP mapping for a user */ "enterprise-admin/update-ldap-mapping-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -75545,25 +83038,32 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ldap-mapping-user"]; }; }; }; }; - /** - * Sync LDAP mapping for a user - * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. - */ "enterprise-admin/sync-ldap-mapping-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { status?: string; @@ -75572,8 +83072,13 @@ export interface operations { }; }; }; - /** Create an organization */ "enterprise-admin/create-org": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -75589,18 +83094,24 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-simple"]; }; }; }; }; - /** Update an organization name */ "enterprise-admin/update-org-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -75613,6 +83124,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -75622,27 +83136,41 @@ export interface operations { }; }; }; - /** List pre-receive environments */ "enterprise-admin/list-pre-receive-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "name"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"][]; }; }; }; }; - /** Create a pre-receive environment */ "enterprise-admin/create-pre-receive-environment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -75656,51 +83184,62 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** Get a pre-receive environment */ "enterprise-admin/get-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** - * Delete a pre-receive environment - * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ - */ "enterprise-admin/delete-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -75714,15 +83253,15 @@ export interface operations { }; }; }; - /** - * Update a pre-receive environment - * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. - */ "enterprise-admin/update-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -75737,12 +83276,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -75756,32 +83301,32 @@ export interface operations { }; }; }; - /** - * Start a pre-receive environment download - * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. - * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ - */ "enterprise-admin/start-pre-receive-environment-download": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -75795,47 +83340,65 @@ export interface operations { }; }; }; - /** - * Get the download status for a pre-receive environment - * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. - */ "enterprise-admin/get-download-status-for-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; }; }; - /** List pre-receive hooks */ "enterprise-admin/list-pre-receive-hooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "name"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"][]; }; }; }; }; - /** Create a pre-receive hook */ "enterprise-admin/create-pre-receive-hook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -75861,48 +83424,68 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** Get a pre-receive hook */ "enterprise-admin/get-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** Delete a pre-receive hook */ "enterprise-admin/delete-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a pre-receive hook */ "enterprise-admin/update-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -75929,28 +83512,34 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** - * List personal access tokens - * @description Lists personal access tokens for all users, including admin users. - */ "enterprise-admin/list-personal-access-tokens": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"][]; @@ -75958,42 +83547,42 @@ export interface operations { }; }; }; - /** - * Delete a personal access token - * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. - */ "enterprise-admin/delete-personal-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the token. */ token_id: components["parameters"]["token-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. - * - * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. - * - * If the login name or email address is already associated with an account, the server will return a `422` response. - */ "enterprise-admin/create-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { /** @description The user's username. */ login: string; - /** - * @description **Required for built-in authentication.** The user's email - * address. This parameter can be omitted when using CAS, LDAP, or SAML. - * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." - */ + /** @description **Required for built-in authentication.** The user's email + * address. This parameter can be omitted when using CAS, LDAP, or SAML. + * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." */ email?: string; /** * @description Whether to set the user as suspended when the user is created. @@ -76006,37 +83595,45 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"]; }; }; }; }; - /** - * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/users#suspend-a-user) is often a better option. - * - * You can delete any user account except your own. - */ "enterprise-admin/delete-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update the username for a user */ "enterprise-admin/update-username-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -76049,6 +83646,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -76058,12 +83658,15 @@ export interface operations { }; }; }; - /** Create an impersonation OAuth token */ "enterprise-admin/create-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -76076,38 +83679,45 @@ export interface operations { responses: { /** @description Response when getting an existing impersonation OAuth token */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; /** @description Response when creating a new impersonation OAuth token */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; }; }; - /** Delete an impersonation OAuth token */ "enterprise-admin/delete-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List global security advisories - * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. - * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/enterprise-server@3.11/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." - */ "security-advisories/list-global-advisories": { parameters: { query?: { @@ -76121,51 +83731,51 @@ export interface operations { ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ severity?: "unknown" | "low" | "medium" | "high" | "critical"; - /** - * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. * - * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` - */ + * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` */ cwes?: string | string[]; /** @description Whether to only return advisories that have been withdrawn. */ is_withdrawn?: boolean; - /** - * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. - * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + /** @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` - */ + * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ affects?: string | string[]; - /** - * @description If specified, only return advisories that were published on a date or date range. + /** @description If specified, only return advisories that were published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ published?: string; - /** - * @description If specified, only return advisories that were updated on a date or date range. + /** @description If specified, only return advisories that were updated on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ updated?: string; - /** - * @description If specified, only show advisories that were updated or published on a date or date range. + /** @description If specified, only show advisories that were updated or published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description The property to sort the results by. */ sort?: "updated" | "published"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-advisory"][]; }; @@ -76173,25 +83783,32 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; /** @description Too many requests */ 429: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get a global security advisory - * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. - */ "security-advisories/get-global-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-advisory"]; }; @@ -76199,35 +83816,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; }; }; }; - /** - * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ "apps/create-from-manifest": { parameters: { + query?: never; + header?: never; path: { code: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"] & { client_id: string; @@ -76242,29 +83866,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a webhook configuration for an app - * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an app - * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -76278,29 +83906,35 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an app webhook - * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -76309,21 +83943,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for an app webhook - * @description Returns a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -76332,38 +83967,41 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an app webhook - * @description Redeliver a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List installation requests for the authenticated app - * @description Lists all the pending installation requests for the authenticated GitHub App. - */ "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of integration installation requests */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration-installation-request"][]; }; @@ -76372,26 +84010,28 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List installations for the authenticated app - * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * The permissions the installation has are included under the `permissions` key. - */ "apps/list-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; outdated?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description The permissions the installation has are included under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -76539,11 +84179,11 @@ export interface operations { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ permissions: { /** @@ -76726,12 +84366,10 @@ export interface operations { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -76813,21 +84451,23 @@ export interface operations { }; }; }; - /** - * Get an installation for the authenticated app - * @description Enables an authenticated GitHub App to find an installation's information using the installation id. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -76835,43 +84475,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#suspend-an-app-installation)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/delete-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. - * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. - * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/create-installation-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -76881,8 +84515,8 @@ export interface operations { /** * @description List of repository IDs that the token should have access to * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -76892,6 +84526,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation-token"]; }; @@ -76902,67 +84539,71 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/suspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unsuspend an app installation - * @description Removes a GitHub App installation suspension. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/unsuspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List your grants - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. - */ "oauth-authorizations/list-grants": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The client ID of your GitHub app. */ client_id?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["application-grant"][]; @@ -76974,20 +84615,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a single grant - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-grant": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the grant. */ grant_id: components["parameters"]["grant-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["application-grant"]; }; @@ -76997,39 +84641,39 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a grant - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "oauth-authorizations/delete-grant": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the grant. */ grant_id: components["parameters"]["grant-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "apps/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77042,20 +84686,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. - */ "apps/check-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77068,6 +84715,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -77076,15 +84726,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. - */ "apps/delete-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77097,20 +84747,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ "apps/reset-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77123,6 +84776,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -77130,23 +84786,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a scoped access token - * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. - * - * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. - */ "apps/scope-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77171,8 +84819,8 @@ export interface operations { /** * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -77182,6 +84830,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -77192,19 +84843,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - */ "apps/get-by-slug": { parameters: { + query?: never; + header?: never; path: { app_slug: components["parameters"]["app-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; @@ -77213,25 +84867,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List your authorizations - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/list-authorizations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The client ID of your GitHub app. */ client_id?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"][]; @@ -77243,31 +84899,22 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a new authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. - * - * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.11/articles/creating-an-access-token-for-command-line-use). - * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.11/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. - */ "oauth-authorizations/create-authorization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -77292,6 +84939,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -77304,24 +84952,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get-or-create an authorization for a specific app - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-or-create-authorization-for-app": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the OAuth app. */ client_id: components["parameters"]["oauth-client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77331,9 +84970,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -77354,6 +84993,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -77364,6 +85004,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -77375,23 +85016,16 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get-or-create an authorization for a specific app and fingerprint - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - */ "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the OAuth app. */ client_id: components["parameters"]["oauth-client-id"]; fingerprint: string; }; + cookie?: never; }; requestBody: { content: { @@ -77401,9 +85035,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -77422,6 +85056,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -77432,6 +85067,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -77440,20 +85076,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a single authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -77463,41 +85102,39 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete an authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Update an existing authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.11/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.11/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * You can only send one of these scope keys at a time. - */ "oauth-authorizations/update-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -77505,9 +85142,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @description A list of scopes to add to this authorization. */ @@ -77529,6 +85166,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -77536,14 +85176,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all codes of conduct - * @description Returns array of all GitHub's codes of conduct. - */ "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"][]; }; @@ -77551,19 +85197,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a code of conduct - * @description Returns information about the specified GitHub code of conduct. - */ "codes-of-conduct/get-conduct-code": { parameters: { + query?: never; + header?: never; path: { key: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"]; }; @@ -77572,54 +85221,74 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get emojis - * @description Lists all the emojis available to use on GitHub Enterprise Server. - */ "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { - [key: string]: string; + [key: string]: string | undefined; }; }; }; 304: components["responses"]["not_modified"]; }; }; - /** - * Get the global announcement banner - * @description Gets the current message and expiration date of the global announcement banner in your enterprise. - */ "enterprise-admin/get-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** - * Remove the global announcement banner - * @description Removes the global announcement banner in your enterprise. - */ "enterprise-admin/remove-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set the global announcement banner - * @description Sets the message and expiration time for the global announcement banner in your enterprise. - */ "enterprise-admin/set-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["announcement"]; @@ -77628,178 +85297,292 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** Get license information */ "enterprise-admin/get-license-information": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-info"]; }; }; }; }; - /** Get all statistics */ "enterprise-admin/get-all-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-overview"]; }; }; }; }; - /** Get comment statistics */ "enterprise-admin/get-comment-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-comment-overview"]; }; }; }; }; - /** Get gist statistics */ "enterprise-admin/get-gist-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-gist-overview"]; }; }; }; }; - /** Get hooks statistics */ "enterprise-admin/get-hooks-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-hook-overview"]; }; }; }; }; - /** Get issue statistics */ "enterprise-admin/get-issue-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-issue-overview"]; }; }; }; }; - /** Get milestone statistics */ "enterprise-admin/get-milestone-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-milestone-overview"]; }; }; }; }; - /** Get organization statistics */ "enterprise-admin/get-org-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-organization-overview"]; }; }; }; }; - /** Get pages statistics */ "enterprise-admin/get-pages-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-page-overview"]; }; }; }; }; - /** Get pull request statistics */ "enterprise-admin/get-pull-request-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-pull-request-overview"]; }; }; }; }; - /** Get repository statistics */ "enterprise-admin/get-repo-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-repository-overview"]; }; }; }; }; - /** - * Get security products statistics - * @description Gets the statistics about security products for a GitHub Enterprise Server instance. - * - * To use this endpoint, you must be a site admin. - */ "enterprise-admin/get-security-products": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-security-products-overview"]; }; }; }; }; - /** Get users statistics */ "enterprise-admin/get-user-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-user-overview"]; }; }; }; }; - /** - * Get GitHub Actions cache usage for an enterprise - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -77807,23 +85590,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage policy for an enterprise - * @description Gets the GitHub Actions cache usage policy for an enterprise. - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-actions-cache-usage-policy-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-policy-enterprise"]; @@ -77831,17 +85614,15 @@ export interface operations { }; }; }; - /** - * Set GitHub Actions cache usage policy for an enterprise - * @description Sets the GitHub Actions cache usage policy for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-actions-cache-usage-policy-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77851,42 +85632,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Actions permissions for an enterprise - * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-enterprise-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an enterprise - * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77899,29 +85683,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -77931,17 +85721,15 @@ export interface operations { }; }; }; - /** - * Set selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -77954,82 +85742,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected organization for GitHub Actions in an enterprise - * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/enable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected organization for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/disable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an enterprise - * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an enterprise - * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78039,46 +85836,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an enterprise - * @description 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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an enterprise - * @description 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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78088,30 +85884,37 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an enterprise - * @description Lists all self-hosted runner groups for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this organization. */ visible_to_organization?: components["parameters"]["visible-to-organization"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -78121,17 +85924,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an enterprise - * @description Creates a new self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78165,66 +85966,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Get a self-hosted runner group for an enterprise - * @description Gets a specific self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an enterprise - * @description Deletes a self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an enterprise - * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -78255,32 +86064,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * List organization access to a self-hosted runner group in an enterprise - * @description Lists the organizations with access to a self-hosted runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -78290,18 +86106,17 @@ export interface operations { }; }; }; - /** - * Set organization access for a self-hosted runner group in an enterprise - * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78314,74 +86129,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add organization access to a self-hosted runner group in an enterprise - * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove organization access to a self-hosted runner group in an enterprise - * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an enterprise - * @description Lists the self-hosted runners that are in a specific enterprise group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -78392,18 +86220,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an enterprise - * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78416,75 +86243,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an enterprise - * @description Adds a self-hosted runner to a runner group configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an enterprise - * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an enterprise - * @description Lists all self-hosted runners configured for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -78495,38 +86334,38 @@ export interface operations { }; }; }; - /** - * List runner applications for an enterprise - * @description Lists binaries for the runner application that you can download and run. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for an Enterprise - * @description Generates a configuration that can be passed to the runner application at startup. - * - * OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78551,138 +86390,129 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for an enterprise - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. - * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-registration-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an enterprise - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. - * - * Example using remove token: - * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-remove-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an enterprise - * @description Gets a specific self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an enterprise - * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an enterprise - * @description Lists all labels for a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an enterprise - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78698,18 +86528,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an enterprise - * @description Add custom labels to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78725,114 +86554,128 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an enterprise - * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an enterprise - * @description 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. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get the audit log for an enterprise - * @description Gets the audit log for an enterprise. - * - * The authenticated user must be an enterprise admin to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-enterprise-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an enterprise - * @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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. - */ "code-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -78842,23 +86685,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get code security and analysis features for an enterprise - * @description Gets code security and analysis settings for the specified enterprise. - * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/get-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-security-analysis-settings"]; }; @@ -78866,19 +86709,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update code security and analysis features for an enterprise - * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/patch-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody?: { content: { @@ -78891,10 +86730,8 @@ export interface operations { secret_scanning_enabled_for_new_repositories?: boolean; /** @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/enterprise-server@3.11/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; - /** - * @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/enterprise-server@3.11/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." - * To disable this functionality, set this field to `null`. - */ + /** @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/enterprise-server@3.11/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; }; }; @@ -78902,48 +86739,75 @@ export interface operations { responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * 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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. - */ "dependabot/list-alerts-for-enterprise": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -78954,32 +86818,42 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List secret scanning alerts for an enterprise - * @description 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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - */ "secret-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -78989,27 +86863,28 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get GitHub Advanced Security active committers for an enterprise - * @description 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. - */ "billing/get-github-advanced-security-billing-ghe": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; @@ -79017,48 +86892,61 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; }; }; - /** - * Enable or disable a security feature - * @description Enables or disables the specified security feature for all repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/post-security-product-enablement-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["enterprise-security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ enablement: components["parameters"]["enterprise-security-product-enablement"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. - */ "activity/list-public-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -79068,49 +86956,47 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get feeds - * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. - * - * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. - * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.11/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. - */ "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["feed"]; }; }; }; }; - /** - * List gists for the authenticated user - * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: - */ "gists/list": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -79120,13 +87006,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a gist - * @description Allows you to add a new gist with one or more files. - * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - */ "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -79138,16 +87024,18 @@ export interface operations { /** * @description Names and content for the files that make up the gist * @example { - * "hello.rb": { - * "content": "puts \"Hello, World!\"" - * } - * } + * "hello.rb": { + * "content": "puts \"Hello, World!\"" + * } + * } */ files: { - [key: string]: { - /** @description Content of the file */ - content: string; - }; + [key: string]: + | { + /** @description Content of the file */ + content: string; + } + | undefined; }; public?: boolean | ("true" | "false"); }; @@ -79159,6 +87047,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"]; @@ -79170,25 +87059,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List public gists - * @description List public gists sorted by most recently updated to least recently updated. - * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - */ "gists/list-public": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -79199,23 +87090,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List starred gists - * @description List the authenticated user's starred gists: - */ "gists/list-starred": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -79226,24 +87121,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a gist - * @description Gets a specified gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -79253,32 +87147,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist */ "gists/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist - * @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. - */ "gists/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79290,23 +87191,25 @@ export interface operations { description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. + * (including extension) of the targeted gist file. For example: `hello.py`. * - * To delete a file, set the whole file to null. For example: `hello.py : null`. + * To delete a file, set the whole file to null. For example: `hello.py : null`. * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } */ files?: { - [key: string]: { - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - }; + [key: string]: + | { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + } + | undefined; }; } | null; }; @@ -79314,6 +87217,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -79322,30 +87228,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List gist comments - * @description Lists the comments on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/list-comments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"][]; @@ -79356,20 +87260,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a gist comment - * @description Creates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79388,6 +87287,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"]; @@ -79398,25 +87298,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist comment - * @description Gets a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -79426,39 +87326,43 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist comment */ "gists/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist comment - * @description Updates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79474,6 +87378,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -79481,23 +87388,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist commits */ "gists/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-commit"][]; @@ -79508,22 +87421,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist forks */ "gists/list-forks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"][]; @@ -79534,19 +87453,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Fork a gist */ "gists/fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"]; @@ -79558,84 +87482,104 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Check if a gist is starred */ "gists/check-is-starred": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if gist is starred */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; }; }; - /** - * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "gists/star": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** Unstar a gist */ "gists/unstar": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist revision - * @description Gets a specified gist revision. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-revision": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -79645,14 +87589,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#create-a-repository-for-the-authenticated-user). - */ "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -79660,23 +87610,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a gitignore template - * @description Get the content of a gitignore template. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. - */ "gitignore/get-template": { parameters: { + query?: never; + header?: never; path: { name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gitignore-template"]; }; @@ -79684,22 +87633,25 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * List repositories accessible to the app installation - * @description List repositories that an app installation can access. - */ "apps/list-repos-accessible-to-installation": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79715,38 +87667,24 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Revoke an installation access token - * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. - * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - */ "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List issues assigned to the authenticated user - * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list": { parameters: { query?: { @@ -79760,24 +87698,34 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; collab?: boolean; orgs?: boolean; owned?: boolean; pulls?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -79788,21 +87736,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get-all-commonly-used": { parameters: { query?: { featured?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-simple"][]; }; @@ -79810,19 +87763,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get": { parameters: { + query?: never; + header?: never; path: { license: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license"]; }; @@ -79832,71 +87788,98 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.11/admin/enterprise-management/configuring-clustering/about-clustering)." - */ "enterprise-admin/get-config-nodes": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-config-nodes"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the status of maintenance mode - * @description Gets the status and details of maintenance mode on all available nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." - */ "enterprise-admin/get-manage-maintenance": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-get-maintenance"]; }; }; /** @description Bad request */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set the status of maintenance mode - * @description Sets or schedules the maintenance mode. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." - */ "enterprise-admin/set-manage-maintenance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["ghes-set-maintenance-request"]; @@ -79905,83 +87888,121 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-set-maintenance-response"]; }; }; /** @description Bad request */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the status of services running on all replica nodes - * @description Gets the status of all services running on each replica node. - * This endpoint may take several seconds to reply. - */ "enterprise-admin/get-replication-status": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-replication-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.11/admin/all-releases)." - */ "enterprise-admin/get-version": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-version"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Render a Markdown document */ "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -80007,6 +88028,7 @@ export interface operations { /** @example 279 */ "Content-Length"?: string; "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -80015,11 +88037,13 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Render a Markdown document in raw mode - * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - */ "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "text/plain": string; @@ -80031,6 +88055,7 @@ export interface operations { 200: { headers: { "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -80039,11 +88064,20 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** Get GitHub Enterprise Server meta information */ "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["api-overview"]; }; @@ -80051,21 +88085,30 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ "activity/list-public-events-for-repo-network": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -80076,27 +88119,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List notifications for the authenticated user - * @description List all notifications for the current user, sorted by most recently updated. - */ "activity/list-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -80108,11 +88157,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -80129,6 +88180,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -80137,26 +88191,33 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread - * @description Gets information about a notification thread. - */ "activity/get-thread": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread"]; }; @@ -80166,40 +88227,46 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Mark a thread as read - * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. - */ "activity/mark-thread-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription). - * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - */ "activity/get-thread-subscription-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -80209,19 +88276,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Set a thread subscription - * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. - * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint. - */ "activity/set-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80237,6 +88300,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -80246,65 +88312,73 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. - */ "activity/delete-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get Octocat - * @description Get the octocat as ASCII art - */ "meta/get-octocat": { parameters: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/octocat-stream": string; }; }; }; }; - /** - * List organizations - * @description Lists all organizations, in the order that they were created. - * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. - */ "orgs/list": { parameters: { query?: { + /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -80313,28 +88387,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Deprecated - List custom repository roles in an organization - * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.11/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. - * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-roles": { parameters: { + query?: never; + header?: never; path: { /** @description The unique identifier of the organization. */ organization_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -80348,38 +88417,23 @@ export interface operations { }; }; }; - /** - * Get an organization - * @description Gets information about an organization. - * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.11/articles/securing-your-account-with-two-factor-authentication-2fa/). - * - * To see the full details about an organization, the authenticated user must be an organization owner. - * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. - * - * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. - */ "orgs/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -80387,54 +88441,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization - * @description Deletes an organization and all its repositories. - * - * The organization login will be unavailable for 90 days after deletion. - * - * Please review the Terms of Service regarding account deletion before using this endpoint: - * - * https://docs.github.com/enterprise-server@3.11/site-policy/github-terms/github-terms-of-service - */ "orgs/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server 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). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.11/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80476,7 +88508,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -80497,53 +88529,41 @@ export interface operations { web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ blog?: string; - /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + /** @description Whether Dependabot alerts is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + /** @description Whether Dependabot security updates is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** - * @description Whether dependency graph is automatically enabled for new repositories. + /** @description Whether dependency graph is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning is automatically enabled for new repositories. + /** @description Whether secret scanning is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + /** @description Whether secret scanning push protection is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -80555,6 +88575,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -80562,6 +88585,9 @@ export interface operations { 409: components["responses"]["conflict"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -80570,24 +88596,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage for an organization - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -80595,28 +88620,28 @@ export interface operations { }; }; }; - /** - * List repositories with GitHub Actions cache usage for an organization - * @description Lists repositories and their 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-by-repo-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -80627,38 +88652,38 @@ export interface operations { }; }; }; - /** - * Get the customization template for an OIDC subject claim for an organization - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "oidc/get-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A JSON serialized template for OIDC subject claim customization */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub"]; }; }; }; }; - /** - * Set the customization template for an OIDC subject claim for an organization - * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "oidc/update-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80668,6 +88693,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -80676,40 +88704,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GitHub Actions permissions for an organization - * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-organization-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an organization - * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80722,29 +88748,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80754,18 +88786,15 @@ export interface operations { }; }; }; - /** - * Set selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-selected-repositories-enabled-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80778,86 +88807,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/enable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/disable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an organization - * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an organization - * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80867,46 +88901,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an organization - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an organization - * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80916,34 +88949,44 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an organization - * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runner-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ visible_to_repository?: components["parameters"]["visible-to-repository"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80953,17 +88996,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an organization - * @description Creates a new self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/create-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80998,66 +89039,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Get a self-hosted runner group for an organization - * @description Gets a specific self-hosted runner group for an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an organization - * @description Deletes a self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-group-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an organization - * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/update-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81087,32 +89136,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * List repository access to a self-hosted runner group in an organization - * @description Lists the repositories with access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81122,18 +89178,17 @@ export interface operations { }; }; }; - /** - * Set repository access for a self-hosted runner group in an organization - * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81146,74 +89201,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add repository access to a self-hosted runner group in an organization - * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove repository access to a self-hosted runner group in an organization - * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an organization - * @description Lists self-hosted runners that are in a specific organization group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runners-in-group-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81224,18 +89292,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an organization - * @description Replaces the list of self-hosted runners that are part of an organization runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-self-hosted-runners-in-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81248,77 +89315,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an organization - * @description Adds a self-hosted runner to a runner group configured in an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-self-hosted-runner-to-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an organization - * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-self-hosted-runner-from-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an organization - * @description Lists all self-hosted runners configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-self-hosted-runners-for-org": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81329,42 +89406,38 @@ export interface operations { }; }; }; - /** - * List runner applications for an organization - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-runner-applications-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for an organization - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the organization. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -81389,145 +89462,129 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for an organization - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an organization - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an organization - * @description Gets a specific self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/get-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an organization - * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an organization - * @description Lists all labels for a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an organization - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-custom-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81543,20 +89600,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an organization - * @description Adds custom labels to a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81572,77 +89626,67 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an organization - * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an organization - * @description Remove a custom label from a self-hosted runner configured - * in an organization. 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. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-custom-label-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81653,138 +89697,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "actions/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81806,61 +89777,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81870,22 +89849,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81898,91 +89872,97 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization variables - * @description Lists all organization variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81993,19 +89973,15 @@ export interface operations { }; }; }; - /** - * Create an organization variable - * @description Creates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82027,72 +90003,74 @@ export interface operations { responses: { /** @description Response when creating a variable */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an organization variable - * @description Gets a specific variable in an organization. - * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-variable"]; }; }; }; }; - /** - * Delete an organization variable - * @description Deletes an organization variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an organization variable - * @description Updates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/update-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -82114,33 +90092,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization variable - * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-variable": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -82150,26 +90132,24 @@ export interface operations { }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set selected repositories for an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -82182,118 +90162,135 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get announcement banner for organization - * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. - */ "announcement-banners/get-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Remove announcement banner from organization - * @description Removes the announcement banner currently set for the organization. - */ "announcement-banners/remove-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set announcement banner for organization - * @description Sets the announcement banner to display for the organization. - */ "announcement-banners/set-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82303,65 +90300,77 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." - * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.11/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." - * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. - */ "orgs/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-org": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; @@ -82370,15 +90379,20 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -82388,23 +90402,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-repo-roles": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -82418,19 +90432,15 @@ export interface operations { }; }; }; - /** - * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/create-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82440,6 +90450,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -82448,24 +90461,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/get-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -82473,43 +90487,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a custom repository role - * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/delete-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/update-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82519,6 +90530,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -82527,37 +90541,60 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List Dependabot alerts for an organization - * @description Lists Dependabot alerts for an organization. - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-org": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -82569,28 +90606,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -82601,134 +90638,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "dependabot/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -82750,57 +90718,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -82810,20 +90790,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -82836,79 +90813,92 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.11/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get list of conflicting packages during Docker migration for organization - * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -82917,73 +90907,84 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ "activity/list-public-org-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * Get an external group - * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/external-idp-group-info-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the group. */ group_id: components["parameters"]["group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List external groups in an organization - * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-external-idp-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description Page token */ page?: number; /** @description Limits the list to groups containing the text in the group name */ display_name?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["external-groups"]; @@ -82991,28 +90992,28 @@ export interface operations { }; }; }; - /** - * List organization webhooks - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"][]; @@ -83021,20 +91022,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization webhook - * @description Create a hook that posts payloads in JSON format. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83055,8 +91051,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -83073,6 +91069,7 @@ export interface operations { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"]; @@ -83082,26 +91079,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -83109,47 +91105,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83164,8 +91154,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -83181,6 +91171,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -83189,46 +91182,42 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for an organization - * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an organization - * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83243,36 +91232,40 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an organization webhook - * @description Returns a list of webhook deliveries for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -83281,26 +91274,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook delivery for an organization webhook - * @description Returns a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -83309,99 +91302,95 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an organization webhook - * @description Redeliver a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) - * to be sent to the hook. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an organization installation for the authenticated app - * @description Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-org-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. - */ "orgs/list-app-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -83412,22 +91401,6 @@ export interface operations { }; }; }; - /** - * List organization issues assigned to the authenticated user - * @description List issues in an organization assigned to the authenticated user. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-org": { parameters: { query?: { @@ -83441,23 +91414,33 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -83466,10 +91449,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization members - * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. - */ "orgs/list-members": { parameters: { query?: { @@ -83477,18 +91456,25 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -83497,69 +91483,88 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Check organization membership for a user - * @description Check if a user is, publicly or privately, a member of the organization. - */ "orgs/check-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if requester is an organization member and user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if requester is not an organization member */ 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization member - * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - */ "orgs/remove-member": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get organization membership for a user - * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. - */ "orgs/get-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -83568,32 +91573,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set organization membership for a user - * @description Only authenticated organization owners can add a member to the organization or update the member's role. - * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.11/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. - * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. - * - * **Rate limits** - * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. - */ "orgs/set-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. * @default member * @enum {string} */ @@ -83604,6 +91602,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -83612,51 +91613,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove organization membership for a user - * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - */ "orgs/remove-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List organization migrations - * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). - * - * A list of `repositories` is only returned for export migrations. - */ "migrations/list-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -83664,17 +91669,15 @@ export interface operations { }; }; }; - /** - * Start an organization migration - * @description Initiates the generation of a migration archive. - * - * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.11/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." - */ "migrations/start-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83729,6 +91732,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -83737,36 +91743,31 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization migration status - * @description Fetches the status of a migration. - * - * The `state` of a migration can be one of the following values: - * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ "migrations/get-status-for-org": { parameters: { query?: { /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** - * @description * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -83774,84 +91775,104 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download an organization migration archive - * @description Fetches the URL to a migration archive. - */ "migrations/download-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization migration archive - * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. - */ "migrations/delete-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. - */ "migrations/unlock-repo-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List repositories in an organization migration - * @description List all the repositories for this organization migration. - */ "migrations/list-repos-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -83860,27 +91881,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List outside collaborators for an organization - * @description List all users who are outside collaborators of an organization. - */ "orgs/list-outside-collaborators": { parameters: { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -83888,16 +91912,17 @@ export interface operations { }; }; }; - /** - * Convert an organization member to outside collaborator - * @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/enterprise-server@3.11/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-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." - */ "orgs/convert-member-to-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83913,39 +91938,56 @@ export interface operations { responses: { /** @description User is getting converted asynchronously */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description User was converted */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @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/enterprise-server@3.11/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Remove outside collaborator from an organization - * @description Removing a user from this list will remove them from all the organization's repositories. - */ "orgs/remove-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -83955,12 +91997,6 @@ export interface operations { }; }; }; - /** - * List packages for an organization - * @description Lists packages in an organization readable by the user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-organization": { parameters: { query: { @@ -83972,19 +92008,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -83994,112 +92041,120 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for an organization - * @description Gets a specific package in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for an organization - * @description Restores an entire package in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-org": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by an organization - * @description Lists package versions for a package owned by an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -84109,116 +92164,131 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for an organization - * @description Gets a specific package version in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for an organization - * @description Restores a specific package version in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-requests": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; @@ -84230,17 +92300,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-requests-in-bulk": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84265,19 +92333,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-request": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; requestBody: { content: { @@ -84300,29 +92366,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-request-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -84333,34 +92400,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grants": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant"][]; @@ -84372,17 +92447,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-accesses": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84405,18 +92478,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-access": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the fine-grained personal access token. */ pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84437,29 +92509,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the fine-grained personal access token. */ pat_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -84470,79 +92543,99 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List pre-receive hooks for an organization - * @description List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. - */ "enterprise-admin/list-pre-receive-hooks-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The sort order for the response collection. */ sort?: "created" | "updated" | "name"; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"][]; }; }; }; }; - /** Get a pre-receive hook for an organization */ "enterprise-admin/get-pre-receive-hook-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * Remove pre-receive hook enforcement for an organization - * @description Removes any overrides for this hook at the org level for this org. - */ "enterprise-admin/remove-pre-receive-hook-enforcement-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * Update pre-receive hook enforcement for an organization - * @description For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration` - */ "enterprise-admin/update-pre-receive-hook-enforcement-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84557,33 +92650,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-org": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -84592,15 +92691,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84615,6 +92714,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -84626,25 +92728,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public organization members - * @description Members of an organization can choose to have their membership publicized or not. - */ "orgs/list-public-members": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -84652,73 +92757,83 @@ export interface operations { }; }; }; - /** - * Check public organization membership for a user - * @description Check if the provided user is a public member of the organization. - */ "orgs/check-public-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a public member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a public member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set public organization membership for the authenticated user - * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "orgs/set-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Remove public organization membership for the authenticated user - * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. - */ "orgs/remove-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization repositories - * @description 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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/list-for-org": { parameters: { query?: { @@ -84735,18 +92850,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -84754,17 +92876,15 @@ export interface operations { }; }; }; - /** - * Create an organization repository - * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84782,7 +92902,7 @@ export interface operations { private?: boolean; /** * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.11/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. - * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. * @enum {string} */ visibility?: "public" | "private" | "internal"; @@ -84857,34 +92977,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -84901,6 +93021,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -84910,46 +93031,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-repo-fine-grained-permissions": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-fine-grained-permission"][]; }; }; }; }; - /** - * Get all organization repository rulesets - * @description Get all the repository rulesets for an organization. - */ "repos/get-org-rulesets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"][]; }; @@ -84958,15 +93084,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create an organization repository ruleset - * @description Create a repository ruleset for an organization. - */ "repos/create-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; /** @description Request body */ requestBody: { @@ -84991,6 +93117,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -84999,21 +93128,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get an organization repository ruleset - * @description Get a repository ruleset for an organization. - */ "repos/get-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -85022,17 +93155,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update an organization repository ruleset - * @description Update a ruleset for an organization. - */ "repos/update-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; /** @description Request body */ requestBody?: { @@ -85057,6 +93190,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -85065,57 +93201,69 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete an organization repository ruleset - * @description Delete a ruleset for an organization. - */ "repos/delete-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List secret scanning alerts for an organization - * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-org": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -85125,100 +93273,104 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "orgs/list-security-manager-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - /** - * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/add-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The organization has reached the maximum number of security manager teams. */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/remove-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Advanced Security active committers for an organization - * @description 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. - */ "billing/get-github-advanced-security-billing-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; @@ -85226,25 +93378,28 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; }; }; - /** - * List teams - * @description Lists all teams in an organization that are visible to the authenticated user. - */ "teams/list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -85253,17 +93408,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a team - * @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/enterprise-server@3.11/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/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/about-teams)". - */ "teams/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -85278,21 +93431,21 @@ export interface operations { repo_names?: string[]; /** * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` * @enum {string} */ notification_setting?: @@ -85314,6 +93467,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -85322,22 +93478,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a team by name - * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. - */ "teams/get-by-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -85345,40 +93504,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team - * @description To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - */ "teams/delete-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a team - * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - */ "teams/update-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85389,18 +93548,18 @@ export interface operations { description?: string; /** * @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: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -85420,12 +93579,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -85435,33 +93600,34 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Pinned discussions only filter */ pinned?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -85469,22 +93635,17 @@ export interface operations { }; }; }; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -85504,75 +93665,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85587,38 +93753,43 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -85626,23 +93797,19 @@ export interface operations { }; }; }; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * **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`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -85655,78 +93822,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -85739,20 +93914,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { @@ -85766,21 +93936,31 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -85788,24 +93968,21 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -85829,51 +94006,53 @@ export interface operations { responses: { /** @description Response when the reaction type has already been added to this team discussion comment */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { @@ -85887,20 +94066,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -85908,23 +94096,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -85948,96 +94132,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List a connection between an external group and a team - * @description Lists a connection between a team and an external group. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-linked-external-idp-groups-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-groups"]; }; }; }; }; - /** - * Remove the connection between an external group and a team - * @description Deletes a connection between a team and an external group. - * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update the connection between an external group and a team - * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/link-external-idp-group-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -86053,36 +94251,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List team members - * @description Team members will include the members of child teams. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/list-members-in-org": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -86090,61 +94293,53 @@ export interface operations { }; }; }; - /** - * Get team membership for a user - * @description Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). - */ "teams/get-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ 404: { - content: never; - }; - }; - }; - /** - * Add or update team membership for a user - * @description 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/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. - * - * If 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. - * - * **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}`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-or-update-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86161,71 +94356,85 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user - * @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. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/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}`. - */ "teams/remove-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ "teams/list-projects-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -86233,46 +94442,53 @@ export interface operations { }; }; }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/check-permissions-for-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/add-or-update-project-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86288,10 +94504,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -86301,49 +94523,55 @@ export interface operations { }; }; }; - /** - * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/remove-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team repositories - * @description Lists a team's repositories visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - */ "teams/list-repos-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -86351,60 +94579,64 @@ export interface operations { }; }; }; - /** - * Check team permissions for a repository - * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. - * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/check-permissions-for-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with repository permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team does not have permission for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions - * @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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **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/enterprise-server@3.11/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". - */ "teams/add-or-update-repo-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86420,54 +94652,64 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a repository from a team - * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/remove-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams - * @description Lists the child teams of the team specified by `{team_slug}`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - */ "teams/list-child-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -86475,28 +94717,29 @@ export interface operations { }; }; }; - /** - * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ enablement: components["parameters"]["org-security-product-enablement"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. - * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. * @enum {string} */ query_suite?: "default" | "extended"; @@ -86506,27 +94749,37 @@ export interface operations { responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a project card - * @description Gets information about a project card. - */ "projects/get-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -86537,25 +94790,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project card - * @description Deletes a project card - */ "projects/delete-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -86567,12 +94827,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ "projects/update-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86593,6 +94856,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -86604,12 +94870,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ "projects/move-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86630,6 +94899,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -86638,6 +94910,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -86654,6 +94929,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -86668,19 +94946,23 @@ export interface operations { }; }; }; - /** - * Get a project column - * @description Gets information about a project column. - */ "projects/get-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -86691,32 +94973,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project column - * @description Deletes a project column. - */ "projects/delete-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ "projects/update-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86732,6 +95021,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -86741,27 +95033,30 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List project cards - * @description Lists the project cards in a project. - */ "projects/list-cards": { parameters: { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-card"][]; @@ -86772,25 +95067,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ "projects/create-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** * @description The project card's note * @example Update all gems */ note: string | null; - }, - { + } + | { /** * @description The unique identifier of the content associated with the card * @example 42 @@ -86801,14 +95098,15 @@ export interface operations { * @example PullRequest */ content_type: string; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -86818,6 +95116,9 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -86826,6 +95127,9 @@ export interface operations { }; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -86840,12 +95144,15 @@ export interface operations { }; }; }; - /** Move a project column */ "projects/move-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86861,6 +95168,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -86871,19 +95181,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -86893,25 +95207,32 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ "projects/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Delete Success */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -86924,15 +95245,15 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86965,6 +95286,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -86973,6 +95297,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -86983,33 +95310,39 @@ export interface operations { }; /** @description Not Found if the authenticated user does not have access to the project */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 410: components["responses"]["gone"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ "projects/list-collaborators": { parameters: { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -87022,16 +95355,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ "projects/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87049,7 +95383,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -87058,21 +95395,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ "projects/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -87081,20 +95423,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ "projects/get-permission-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-collaborator-permission"]; }; @@ -87106,25 +95453,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List project columns - * @description Lists the project columns in a project. - */ "projects/list-columns": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-column"][]; @@ -87135,15 +95485,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a project column - * @description Creates a new project column. - */ "projects/create-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87159,6 +95509,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -87169,24 +95522,14 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. - * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.11/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.11/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.11/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.11/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.11/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.11/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.11/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - */ "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -87194,6 +95537,7 @@ export interface operations { "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["rate-limit-overview"]; @@ -87203,22 +95547,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository - * @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. - * - * **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/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -87228,30 +95575,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a repository - * @description Deleting a repository requires admin access. - * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. - * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. - */ "repos/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -87262,16 +95612,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#replace-all-repository-topics) endpoint. - */ "repos/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87284,7 +95635,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -87293,16 +95644,14 @@ export interface operations { * @enum {string} */ visibility?: "public" | "private" | "internal"; - /** - * @description Specify which security and analysis features to enable or disable for the repository. + /** @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.11/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. * - * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { @@ -87376,34 +95725,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -87428,6 +95777,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -87438,31 +95790,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List artifacts for a repository - * @description Lists all artifacts for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-artifacts-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87473,137 +95826,147 @@ export interface operations { }; }; }; - /** - * Get an artifact - * @description Gets a specific artifact for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["artifact"]; }; }; }; }; - /** - * Delete an artifact - * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download an artifact - * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; archive_format: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { Location: components["headers"]["location"]; + [name: string]: unknown; }; - content: never; + content?: never; }; 410: components["responses"]["gone"]; }; }; - /** - * Get GitHub Actions cache usage for a repository - * @description Gets GitHub Actions cache usage for a repository. - * 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. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-by-repository"]; }; }; }; }; - /** - * Get GitHub Actions cache usage policy for a repository - * @description Gets GitHub Actions cache usage policy for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-policy-for-repository"]; }; }; }; }; - /** - * Set GitHub Actions cache usage policy for a repository - * @description Sets GitHub Actions cache usage policy for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-actions-cache-usage-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87613,36 +95976,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List GitHub Actions caches for a repository - * @description Lists the GitHub Actions caches for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; + /** @description An explicit key or prefix for identifying the cache */ key?: components["parameters"]["actions-cache-key"]; + /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ sort?: components["parameters"]["actions-cache-list-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-list"]; @@ -87650,119 +96022,128 @@ export interface operations { }; }; }; - /** - * Delete GitHub Actions caches for a repository (using a cache key) - * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-key": { parameters: { query: { + /** @description A key for identifying the cache. */ key: components["parameters"]["actions-cache-key-required"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - /** - * Delete a GitHub Actions cache for a repository (using a cache ID) - * @description Deletes a GitHub Actions cache for a repository, using a cache ID. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-id": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the GitHub Actions cache. */ cache_id: components["parameters"]["cache-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a job for a workflow run - * @description Gets a specific job in a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["job"]; }; }; }; }; - /** - * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-job-logs-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Re-run a job from a workflow run - * @description Re-run a job and its dependent jobs in a workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87778,6 +96159,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -87785,22 +96169,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get the customization template for an OIDC subject claim for a repository - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub-repo"]; }; @@ -87809,18 +96196,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set the customization template for an OIDC subject claim for a repository - * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87835,6 +96221,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -87844,31 +96233,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository organization secrets - * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87879,30 +96267,30 @@ export interface operations { }; }; }; - /** - * List repository organization variables - * @description Lists all organization variables shared with a repository. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87913,42 +96301,42 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions permissions for a repository - * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. - * - * You 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. - */ "actions/get-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-repository-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for a repository - * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. - * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87961,50 +96349,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-workflow-access-to-repository"]; }; }; }; }; - /** - * Set the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.11/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.11/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88014,48 +96401,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for a repository - * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * You 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. - */ "actions/get-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for a repository - * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88065,48 +96453,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for a repository - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for a repository - * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.11/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88116,40 +96505,46 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning organization or enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for a repository - * @description Lists all self-hosted runners configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88160,44 +96555,42 @@ export interface operations { }; }; }; - /** - * List runner applications for a repository - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-runner-applications-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for a repository - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the repository. - * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88222,151 +96615,141 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for a repository - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for a repository - * @description Gets a specific self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from a repository - * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for a repository - * @description Lists all labels for a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for a repository - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88382,21 +96765,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for a repository - * @description Adds custom labels to a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88412,89 +96793,89 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for a repository - * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for a repository - * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. - * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-custom-label-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List workflow runs for a repository - * @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/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. - */ "actions/list-workflow-runs-for-repo": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-server@3.11/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88505,106 +96886,116 @@ export interface operations { }; }; }; - /** - * Get a workflow run - * @description Gets a specific workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * Delete a workflow run - * @description Deletes a specific workflow run. - * - * Anyone with write access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-reviews-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment-approvals"][]; }; }; }; }; - /** - * List workflow run artifacts - * @description Lists artifacts for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-run-artifacts": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88615,62 +97006,66 @@ export interface operations { }; }; }; - /** - * Get a workflow run attempt - * @description Gets a specific workflow run attempt. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run-attempt": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88682,52 +97077,56 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download workflow run attempt logs - * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-attempt-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Cancel a workflow run - * @description Cancels a workflow run using its `id`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -88735,22 +97134,19 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/review-custom-gates-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88762,38 +97158,41 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List jobs for a workflow run - * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run": { parameters: { query?: { /** @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. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88804,97 +97203,100 @@ export interface operations { }; }; }; - /** - * Download workflow run logs - * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Delete workflow run logs - * @description Deletes all logs for a workflow run. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Get pending deployments for a workflow run - * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pending-deployment"][]; }; }; }; }; - /** - * Review pending deployments for a workflow run - * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. - * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/review-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88902,9 +97304,9 @@ export interface operations { /** * @description The list of environment ids to approve or reject * @example [ - * 161171787, - * 161171795 - * ] + * 161171787, + * 161171795 + * ] */ environment_ids: number[]; /** @@ -88924,25 +97326,28 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"][]; }; }; }; }; - /** - * Re-run a workflow - * @description Re-runs your workflow run using its `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88958,25 +97363,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow-failed-jobs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88992,37 +97400,39 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89033,72 +97443,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -89113,63 +97522,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository variables - * @description Lists all repository variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89180,20 +97597,17 @@ export interface operations { }; }; }; - /** - * Create a repository variable - * @description Creates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -89208,75 +97622,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get a repository variable - * @description Gets a specific variable in a repository. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete a repository variable - * @description Deletes a repository variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a repository variable - * @description Updates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -89291,34 +97710,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository workflows - * @description Lists the workflows in a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-repo-workflows": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89329,68 +97751,71 @@ export interface operations { }; }; }; - /** - * Get a workflow - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow"]; }; }; }; }; - /** - * Disable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/disable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * 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`. - * - * You 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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-workflow-dispatch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89407,64 +97832,80 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/enable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow runs for a workflow - * @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/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-runs": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-server@3.11/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-server@3.11/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89475,39 +97916,30 @@ export interface operations { }; }; }; - /** - * List repository activities - * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. - * - * For more information about viewing repository activity, - * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository)." - */ "repos/list-activities": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; - /** - * @description The Git reference for the activities you want to list. + /** @description The Git reference for the activities you want to list. * - * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. - */ + * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. */ ref?: string; /** @description The GitHub username to use to filter by the actor who performed the activity. */ actor?: string; - /** - * @description The time period to filter by. + /** @description The time period to filter by. * - * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). - */ + * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). */ time_period?: "day" | "week" | "month" | "quarter" | "year"; - /** - * @description The activity type to filter by. + /** @description The activity type to filter by. * - * For example, you can choose to filter by "force_push", to see all force pushes to the repository. - */ + * For example, you can choose to filter by "force_push", to see all force pushes to the repository. */ activity_type?: | "push" | "force_push" @@ -89516,16 +97948,22 @@ export interface operations { | "pr_merge" | "merge_queue_merge"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["activity"][]; @@ -89534,26 +97972,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.11/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. - */ "issues/list-assignees": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -89562,67 +98004,75 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user can be assigned - * @description Checks if a user has permission to be assigned to an issue in this repository. - * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - * - * Otherwise a `404` status code is returned. - */ "issues/check-user-can-be-assigned": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Otherwise a `404` status code is returned. */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get all autolinks of a repository - * @description Gets all autolinks that are configured for a repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/list-autolinks": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"][]; }; }; }; }; - /** - * Create an autolink reference for a repository - * @description Users with admin access to the repository can create an autolink. - */ "repos/create-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -89645,6 +98095,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["autolink"]; @@ -89653,23 +98104,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an autolink reference of a repository - * @description This returns a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/get-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"]; }; @@ -89677,71 +98132,90 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an autolink reference from a repository - * @description This deletes a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/delete-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/enterprise-server@3.11/articles/configuring-automated-security-fixes)". - */ "repos/check-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if dependabot is enabled */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; /** @description Not Found if dependabot is not enabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List branches */ "repos/list-branches": { parameters: { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-branch"][]; @@ -89750,18 +98224,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get a branch */ "repos/get-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -89770,21 +98253,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get branch protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-protection"]; }; @@ -89792,23 +98281,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update branch protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Protecting a branch requires admin or owner permissions to the repository. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. - */ "repos/update-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -89820,6 +98305,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -89899,6 +98385,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch"]; }; @@ -89908,148 +98397,178 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete branch protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get admin branch protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Set admin branch protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/set-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Delete admin branch protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/delete-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get pull request review protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - /** - * Delete pull request review protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update pull request review protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - */ "repos/update-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90089,6 +98608,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; @@ -90096,25 +98618,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get commit signature protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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/enterprise-server@3.11/articles/signing-commits-with-gpg) in GitHub Help. - * - * **Note**: You must enable branch protection to require signed commits. - */ "repos/get-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -90122,23 +98646,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create commit signature protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/create-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -90146,43 +98674,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete commit signature protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/delete-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get status checks protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-status-checks-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -90190,38 +98728,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove status check protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update status check protection - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/update-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90231,6 +98775,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -90246,6 +98791,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -90254,21 +98802,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all status check contexts - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-all-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -90276,17 +98830,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set status check contexts - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/set-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90299,6 +98855,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -90307,17 +98866,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add status check contexts - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/add-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90330,6 +98891,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -90339,17 +98903,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove status check contexts - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90362,6 +98928,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -90370,25 +98939,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists who has access to this protected branch. - * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. - */ "repos/get-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-restriction-policy"]; }; @@ -90396,44 +98967,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Disables the ability to restrict who can push to this branch. - */ "repos/delete-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get apps with access to the protected branch - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/get-apps-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -90441,19 +99020,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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/enterprise-server@3.11/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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/set-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90466,6 +99045,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -90473,19 +99055,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/add-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90498,6 +99080,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -90505,19 +99090,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/remove-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90530,6 +99115,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -90537,23 +99125,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get teams with access to the protected branch - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. The list includes child teams. - */ "repos/get-teams-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -90561,19 +99153,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - */ "repos/set-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90586,6 +99178,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -90593,19 +99188,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified teams push access for this branch. You can also give push access to child teams. - */ "repos/add-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90618,6 +99213,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -90625,19 +99223,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. - */ "repos/remove-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90650,6 +99248,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -90657,23 +99258,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get users with access to the protected branch - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - */ "repos/get-users-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -90681,23 +99286,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set user 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/set-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90710,6 +99311,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -90717,23 +99321,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add user 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified people push access for this branch. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/add-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90746,6 +99346,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -90753,23 +99356,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a user to push to this branch. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/remove-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90782,6 +99381,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -90789,23 +99391,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Rename a branch - * @description Renames a branch in a repository. - * - * **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/enterprise-server@3.11/github/administering-a-repository/renaming-a-branch)". - * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. - */ "repos/rename-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -90818,6 +99416,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -90827,20 +99428,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. - * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - */ "checks/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90866,7 +99464,7 @@ export interface operations { started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ conclusion?: @@ -90940,149 +99538,153 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Get a check run - * @description Gets a single check run using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Update a check run - * @description Updates a check run for a specific commit in a repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The name of the check. For example, "code-coverage". */ - name?: string; - /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; - /** @description A reference for the run on the integrator's system. */ - external_id?: string; - /** - * Format: date-time - * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. - * @enum {string} - */ - status?: - | "queued" - | "in_progress" - | "completed" - | "waiting" - | "requested" - | "pending"; - /** - * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. - * @enum {string} - */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; - /** - * Format: date-time - * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - completed_at?: string; - /** @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. */ - output?: { - /** @description **Required**. */ - title?: string; - /** @description Can contain Markdown. */ - summary: string; - /** @description Can contain Markdown. */ - text?: string; - /** @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/enterprise-server@3.11/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.11/articles/about-status-checks#checks)". */ - annotations?: { - /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; - /** @description The start line of the annotation. Line numbers start at 1. */ - start_line: number; - /** @description The end line of the annotation. */ - end_line: number; - /** @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. */ - start_column?: number; - /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + "application/json": + | { + /** @description The name of the check. For example, "code-coverage". */ + name?: string; + /** @description The URL of the integrator's site that has the full details of the check. */ + details_url?: string; + /** @description A reference for the run on the integrator's system. */ + external_id?: string; /** - * @description The level of the annotation. + * Format: date-time + * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; - /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; - /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; - /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; - /** @description Adds images to the output displayed in the GitHub pull request UI. */ - images?: { - /** @description The alternative text for the image. */ - alt: string; - /** @description The full URL of the image. */ - image_url: string; - /** @description A short image description. */ - caption?: string; - }[]; - }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.11/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - actions?: { - /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; - /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; - /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - } & ( + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; + /** + * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * @enum {string} + */ + conclusion?: + | "action_required" + | "cancelled" + | "failure" + | "neutral" + | "success" + | "skipped" + | "stale" + | "timed_out"; + /** + * Format: date-time + * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** @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. */ + output?: { + /** @description **Required**. */ + title?: string; + /** @description Can contain Markdown. */ + summary: string; + /** @description Can contain Markdown. */ + text?: string; + /** @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/enterprise-server@3.11/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.11/articles/about-status-checks#checks)". */ + annotations?: { + /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** @description The start line of the annotation. Line numbers start at 1. */ + start_line: number; + /** @description The end line of the annotation. */ + end_line: number; + /** @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. */ + start_column?: number; + /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** + * @description The level of the annotation. + * @enum {string} + */ + annotation_level: "notice" | "warning" | "failure"; + /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** @description The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** @description Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + }[]; + /** @description Adds images to the output displayed in the GitHub pull request UI. */ + images?: { + /** @description The alternative text for the image. */ + alt: string; + /** @description The full URL of the image. */ + image_url: string; + /** @description A short image description. */ + caption?: string; + }[]; + }; + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.11/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + actions?: { + /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + }[]; + } | { /** @enum {unknown} */ status?: "completed"; @@ -91092,42 +99694,47 @@ export interface operations { /** @enum {unknown} */ status?: "queued" | "in_progress"; [key: string]: unknown; - } - ); + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-annotations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["check-annotation"][]; @@ -91135,31 +99742,36 @@ export interface operations { }; }; }; - /** - * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.11/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -91167,26 +99779,26 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.11/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#update-repository-preferences-for-check-suites)". - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/create-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91199,29 +99811,35 @@ export interface operations { responses: { /** @description Response when the suite already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.11/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. - */ "checks/set-suites-preferences": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91242,66 +99860,74 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - /** - * Get a check suite - * @description Gets a single check suite using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-suite": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91312,47 +99938,47 @@ export interface operations { }; }; }; - /** - * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List code scanning alerts for a repository - * @description Lists code scanning alerts. - * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; @@ -91361,14 +99987,22 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-items"][]; }; @@ -91379,23 +100013,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning alert - * @description Gets a single code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -91406,18 +100044,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning alert - * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -91431,6 +100070,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -91440,28 +100082,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List instances of a code scanning alert - * @description Lists all instances of the specified code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alert-instances": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-instance"][]; }; @@ -91471,47 +100119,42 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List code scanning analyses for a repository - * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. - * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-recent-analyses": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the analyses 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`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"][]; }; @@ -91521,38 +100164,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning analysis for a repository - * @description Gets a specified code scanning analysis for a repository. - * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. - * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-analysis": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { @@ -91565,89 +100197,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. - * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/delete-analysis": { parameters: { query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ confirm_delete?: string | null; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; @@ -91658,22 +100231,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning default setup configuration - * @description Gets a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup"]; }; @@ -91683,18 +100259,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning default setup configuration - * @description Updates a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91704,12 +100279,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; @@ -91720,47 +100301,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif)." - * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." - * - * You 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: - * - * ``` - * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." - * - * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/upload-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91771,7 +100322,7 @@ export interface operations { /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. - * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ checkout_uri?: string; @@ -91788,40 +100339,53 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ 413: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ sarif_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; @@ -91829,54 +100393,49 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CODEOWNERS errors - * @description List any syntax errors that are detected in the CODEOWNERS - * file. - * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - */ "repos/codeowners-errors": { parameters: { query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository collaborators - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/list-collaborators": { parameters: { query?: { @@ -91884,19 +100443,27 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["collaborator"][]; @@ -91905,60 +100472,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is a repository collaborator - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/check-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a collaborator */ 404: { - content: never; - }; - }; - }; - /** - * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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-server@3.11/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/enterprise-server@3.11/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: - * - * ``` - * Cannot assign {member} permission of {role name} - * ``` - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **Updating an existing collaborator's permission level** - * - * The 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. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -91972,81 +100530,68 @@ export interface operations { }; }; responses: { - /** - * @description Response when: - * - an existing collaborator is added as a collaborator - * - an organization member is added as an individual collaborator - * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator - */ + /** @description Response when: + * - an existing collaborator is added as a collaborator + * - an organization member is added as an individual collaborator + * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository collaborator - * @description Removes a collaborator from a repository. - * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. - * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages - * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. - * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.11/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". - */ "repos/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when collaborator was removed from the repository. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ "repos/get-collaborator-permission-level": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user has admin permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-collaborator-permission"]; }; @@ -92054,33 +100599,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit comments for a repository - * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-commit-comments-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -92088,28 +100630,27 @@ export interface operations { }; }; }; - /** - * Get a commit comment - * @description Gets a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/get-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -92117,41 +100658,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a commit comment */ "repos/delete-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a commit comment - * @description Updates the contents of a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/update-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -92164,6 +100709,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -92171,10 +100719,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). - */ "reactions/list-for-commit-comment": { parameters: { query?: { @@ -92188,20 +100732,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -92210,17 +100763,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. - */ "reactions/create-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -92244,12 +100799,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -92257,59 +100818,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.11/rest/commits/comments#get-a-commit-comment). - */ "reactions/delete-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List commits - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/list-commits": { parameters: { query?: { @@ -92321,22 +100856,31 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -92348,23 +100892,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List branches for HEAD commit - * @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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - */ "repos/list-branches-for-head-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-short"][]; }; @@ -92373,34 +100921,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List commit comments - * @description Lists the comments for a specified commit. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-comments-for-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -92408,26 +100954,19 @@ export interface operations { }; }; }; - /** - * Create a commit comment - * @description Create a comment for a commit using its `:commit_sha`. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/create-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; requestBody: { content: { @@ -92449,6 +100988,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"]; @@ -92458,29 +100998,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. - * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. - */ "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -92489,62 +101032,32 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a commit - * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/get-commit": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; @@ -92556,38 +101069,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.11/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.11/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-ref": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; app_id?: number; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -92598,14 +101112,6 @@ export interface operations { }; }; }; - /** - * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-suites-for-ref": { parameters: { query?: { @@ -92614,21 +101120,31 @@ export interface operations { * @example 1 */ app_id?: number; + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -92639,32 +101155,32 @@ export interface operations { }; }; }; - /** - * Get the combined status for a specific reference - * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - * - * - * Additionally, a combined `state` is returned. The `state` is one of: - * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` - */ "repos/get-combined-status-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-commit-status"]; }; @@ -92672,29 +101188,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit statuses for a reference - * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - */ "repos/list-commit-statuses-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"][]; @@ -92703,75 +101222,32 @@ export interface operations { 301: components["responses"]["moved_permanently"]; }; }; - /** - * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-server@3.11/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. - * - * **Working with large comparisons** - * - * 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. - * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api)." - * - * **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: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits-with-basehead": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @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`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; @@ -92781,50 +101257,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. - * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. - * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - * - * **Notes**: - * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.11/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. - */ "repos/get-content": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/vnd.github.object": components["schemas"]["content-tree"]; "application/json": @@ -92839,22 +101295,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. - * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. - */ "repos/create-or-update-file-contents": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -92891,12 +101344,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -92906,26 +101365,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a file - * @description Deletes a file in a repository. - * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.11/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - */ "repos/delete-file": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -92956,6 +101408,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -92966,30 +101421,32 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository contributors - * @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. - * - * 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. - */ "repos/list-contributors": { parameters: { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If repository contains content */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["contributor"][]; @@ -92997,26 +101454,41 @@ export interface operations { }; /** @description Response if repository is empty */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List Dependabot alerts for a repository - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-repo": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** * @deprecated @@ -93028,19 +101500,35 @@ export interface operations { * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"][]; }; @@ -93052,21 +101540,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a Dependabot alert - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -93076,26 +101573,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.11/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The state of the Dependabot alert. - * A `dismissed_reason` must be provided when setting the state to `dismissed`. + * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ state: "dismissed" | "open"; @@ -93117,6 +101617,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -93128,29 +101631,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -93161,67 +101665,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. - */ "dependabot/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -93236,58 +101744,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a diff of the dependencies between commits - * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. - */ "dependency-graph/diff-range": { parameters: { query?: { + /** @description The full path, relative to the repository root, of the dependency manifest file. */ name?: components["parameters"]["manifest-path"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-diff"]; @@ -93297,22 +101818,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Export a software bill of materials (SBOM) for a repository. - * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. - */ "dependency-graph/export-sbom": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; @@ -93322,20 +101846,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. - * - * The authenticated user must have access to the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependency-graph/create-repository-snapshot": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93345,6 +101866,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description ID of the created snapshot. */ @@ -93360,10 +101884,6 @@ export interface operations { }; }; }; - /** - * List deployments - * @description Simple filtering of deployments is available via query parameters: - */ "repos/list-deployments": { parameters: { query?: { @@ -93374,20 +101894,28 @@ export interface operations { /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment"][]; @@ -93395,63 +101923,17 @@ export interface operations { }; }; }; - /** - * Create a deployment - * @description Deployments offer a few configurable parameters with certain defaults. - * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them - * before we merge a pull request. - * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. - * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. - * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. - * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. - * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. - * - * Merged branch response: - * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts - * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. - * - * Merge conflict response: - * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * Failed commit status checks: - * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93470,14 +101952,11 @@ export interface operations { auto_merge?: boolean; /** @description The [status](https://docs.github.com/enterprise-server@3.11/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; - payload?: OneOf< - [ - { + payload?: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production @@ -93501,12 +101980,18 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -93515,23 +102000,35 @@ export interface operations { }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** Get a deployment */ "repos/get-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; @@ -93539,57 +102036,59 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * To set a deployment as inactive, you must: - * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. - * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.11/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.11/rest/deployments/statuses#create-a-deployment-status)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/delete-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List deployment statuses - * @description Users with pull access can view deployment statuses for a deployment: - */ "repos/list-deployment-statuses": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"][]; @@ -93598,19 +102097,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a deployment status - * @description Users with `push` access can create deployment statuses for a given deployment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -93660,6 +102159,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"]; @@ -93668,22 +102168,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a deployment status - * @description Users with pull access can view a deployment status for a deployment: - */ "repos/get-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; status_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-status"]; }; @@ -93691,22 +102197,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#repository_dispatch)." - * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-dispatch-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93723,34 +102224,39 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List environments - * @description Lists the environments for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -93764,48 +102270,46 @@ export interface operations { }; }; }; - /** - * Get an environment - * @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)." - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; }; }; - /** - * Create or update an environment - * @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)." - * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-or-update-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93830,60 +102334,75 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Delete an environment - * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-an-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List deployment branch policies - * @description Lists the deployment branch policies for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-deployment-branch-policies": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -93897,19 +102416,19 @@ export interface operations { }; }; }; - /** - * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -93919,60 +102438,73 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ 303: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -93982,53 +102514,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-deployment-protection-rules": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of deployment protection rules */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -94042,23 +102584,19 @@ export interface operations { }; }; }; - /** - * Create a custom deployment protection rule on an environment - * @description Enable a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; requestBody: { content: { @@ -94071,37 +102609,41 @@ export interface operations { responses: { /** @description The enabled custom deployment protection rule */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. - * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app)". - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-custom-deployment-rule-integrations": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A list of custom deployment rule integrations available for this environment. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -94115,82 +102657,88 @@ export interface operations { }; }; }; - /** - * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/enterprise-server@3.11/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-server@3.11/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-custom-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * Disable a custom protection rule for an environment - * @description Disables a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/disable-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -94201,75 +102749,77 @@ export interface operations { }; }; }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -94284,65 +102834,75 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -94353,21 +102913,19 @@ export interface operations { }; }; }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -94382,78 +102940,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -94468,53 +103034,69 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - */ "activity/list-repo-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List forks */ "repos/list-forks": { parameters: { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -94523,20 +103105,17 @@ export interface operations { 400: components["responses"]["bad_request"]; }; }; - /** - * Create a fork - * @description Create a fork for the authenticated user. - * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. - */ "repos/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94553,6 +103132,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -94563,13 +103145,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Create a blob */ "git/create-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94590,6 +103176,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-blob"]; @@ -94601,28 +103188,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a blob - * @description The `content` in the response will always be Base64 encoded. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. - * - * **Note** This endpoint supports blobs up to 100 megabytes in size. - */ "git/get-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; file_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["blob"]; }; @@ -94633,45 +103218,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a commit - * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94717,6 +103274,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-commit"]; @@ -94727,52 +103285,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a commit object - * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-commit"]; }; @@ -94781,29 +103314,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List matching references - * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - */ "git/list-matching-refs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"][]; @@ -94812,23 +103346,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a reference - * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - */ "git/get-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -94837,16 +103378,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a reference - * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. - */ "git/create-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94864,6 +103406,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"]; @@ -94873,38 +103416,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a reference - * @description Deletes the provided reference. - */ "git/delete-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a reference - * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - */ "git/update-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; requestBody: { content: { @@ -94922,6 +103479,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -94930,45 +103490,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.11/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95005,6 +103537,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tag"]; @@ -95014,48 +103547,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tag - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; tag_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tag"]; }; @@ -95064,20 +103575,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a tree - * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.11/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.11/rest/git/refs#update-a-reference)." - * - * Returns an error if you try to delete a file that does not exist. - */ "git/create-tree": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95096,23 +103604,18 @@ export interface operations { * @enum {string} */ type?: "blob" | "tree" | "commit"; - /** - * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + /** @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ sha?: string | null; - /** - * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + /** @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ content?: string; }[]; - /** - * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - */ + /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + * */ base_tree?: string; }; }; @@ -95123,6 +103626,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tree"]; @@ -95134,31 +103638,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tree - * @description Returns a single tree using the SHA1 value or ref name for that tree. - * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. - */ "git/get-tree": { parameters: { query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ recursive?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tree"]; }; @@ -95168,26 +103671,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository webhooks - * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. - */ "repos/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"][]; @@ -95196,17 +103703,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository webhook - * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. - */ "repos/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95223,8 +103730,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -95241,6 +103748,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"]; @@ -95251,21 +103759,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." - */ "repos/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -95273,34 +103787,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ "repos/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." - */ "repos/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95309,8 +103834,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ @@ -95328,6 +103853,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -95336,42 +103864,46 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. - */ "repos/get-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. - */ "repos/update-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95386,32 +103918,42 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for a repository webhook - * @description Returns a list of webhook deliveries for a webhook configured in a repository. - */ "repos/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -95420,22 +103962,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for a repository webhook - * @description Returns a delivery for a webhook configured in a repository. - */ "repos/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -95444,83 +103992,99 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for a repository webhook - * @description Redeliver a webhook delivery for a webhook configured in a repository. - */ "repos/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.11/webhooks/#ping-event) to be sent to the hook. - */ "repos/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Test the push repository webhook - * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - */ "repos/test-push-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository installation for the authenticated app - * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-repo-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -95529,26 +104093,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repository invitations - * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. - */ "repos/list-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -95556,30 +104124,44 @@ export interface operations { }; }; }; - /** Delete a repository invitation */ "repos/delete-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a repository invitation */ "repos/update-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95595,28 +104177,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - /** - * List repository issues - * @description List issues in a repository. Only open issues will be listed. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-repo": { parameters: { query?: { @@ -95630,24 +104199,35 @@ export interface operations { creator?: string; /** @description A user that's mentioned in the issue. */ mentioned?: string; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -95658,26 +104238,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.11/articles/disabling-issues/), the API returns a `410 Gone` status. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95688,19 +104259,17 @@ export interface operations { body?: string; /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ assignee?: string | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; }; @@ -95712,6 +104281,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"]; @@ -95725,39 +104295,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List issue comments for a repository - * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. - * - * By default, issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments-for-repo": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -95767,28 +104334,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue comment - * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -95796,43 +104362,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an issue comment - * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - */ "issues/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an issue comment - * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95845,6 +104412,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -95852,10 +104422,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). - */ "reactions/list-for-issue-comment": { parameters: { query?: { @@ -95869,20 +104435,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -95891,17 +104466,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. - */ "reactions/create-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95925,12 +104502,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -95938,48 +104521,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#get-an-issue-comment). - */ "reactions/delete-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List issue events for a repository - * @description Lists events for a repository. - */ "issues/list-events-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event"][]; @@ -95988,21 +104580,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue event - * @description Gets a single event by the event id. - */ "issues/get-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; event_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-event"]; }; @@ -96012,38 +104609,27 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.11/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-server@3.11/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 - * 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/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -96054,30 +104640,25 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update an issue - * @description Issue owners and users with push access can edit an issue. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** @description The title of the issue. */ - title?: string | number | null; + title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; /** @description Username to assign to this issue. **This field is deprecated.** */ @@ -96093,19 +104674,17 @@ export interface operations { * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; }; @@ -96114,6 +104693,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -96126,17 +104708,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Add assignees to an issue - * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - */ "issues/add-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96149,23 +104733,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Remove assignees from an issue - * @description Removes one or more assignees from an issue. - */ "issues/remove-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -96178,73 +104767,78 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Check if a user can be assigned to a issue - * @description 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. - */ "issues/check-user-can-be-assigned-to-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List issue comments - * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * Issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -96254,29 +104848,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create an issue comment - * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -96292,6 +104876,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"]; @@ -96303,27 +104888,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List issue events - * @description Lists all events for an issue. - */ "issues/list-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event-for-issue"][]; @@ -96332,27 +104922,32 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * List labels for an issue - * @description Lists all labels for an issue. - */ "issues/list-labels-on-issue": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -96363,38 +104958,40 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Set labels for an issue - * @description Removes any previous labels and sets the new labels for an issue. - */ "issues/set-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.11/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -96405,38 +105002,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. - */ "issues/add-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.11/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -96447,44 +105046,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all labels from an issue - * @description Removes all labels from an issue. - */ "issues/remove-all-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 301: components["responses"]["moved_permanently"]; 404: components["responses"]["not_found"]; 410: components["responses"]["gone"]; }; }; - /** - * Remove a label from an issue - * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. - */ "issues/remove-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -96494,29 +105105,29 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Lock an issue - * @description Users with push access can lock an issue or pull request's conversation. - * - * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "issues/lock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` * @enum {string} */ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; @@ -96526,7 +105137,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -96534,31 +105148,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unlock an issue - * @description Users with push access can unlock an issue's conversation. - */ "issues/unlock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). - */ "reactions/list-for-issue": { parameters: { query?: { @@ -96572,20 +105188,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -96595,17 +105220,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. - */ "reactions/create-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -96629,12 +105256,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -96642,49 +105275,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.11/rest/issues/issues#get-an-issue). - */ "reactions/delete-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List timeline events for an issue - * @description List all timeline events for an issue. - */ "issues/list-events-for-timeline": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["timeline-issue-events"][]; @@ -96694,23 +105337,30 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** List deploy keys */ "repos/list-deploy-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"][]; @@ -96718,16 +105368,17 @@ export interface operations { }; }; }; - /** - * Create a deploy key - * @description You can create a read-only deploy key. - */ "repos/create-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96736,11 +105387,9 @@ export interface operations { title?: string; /** @description The contents of the key. */ key: string; - /** - * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + /** @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.11/articles/permission-levels-for-a-user-account-repository/)." - */ + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.11/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.11/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; }; @@ -96751,6 +105400,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"]; @@ -96759,18 +105409,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get a deploy key */ "repos/get-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deploy-key"]; }; @@ -96778,45 +105437,55 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a deploy key - * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. - */ "repos/delete-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a repository - * @description Lists all labels for a repository. - */ "issues/list-labels-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -96825,16 +105494,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a label - * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). - */ "issues/create-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96854,6 +105524,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"]; @@ -96863,21 +105534,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a label - * @description Gets a label using the given name. - */ "issues/get-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; @@ -96885,36 +105561,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a label - * @description Deletes a label using the given label name. - */ "issues/delete-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a label - * @description Updates a label using the given label name. - */ "issues/update-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; requestBody?: { content: { @@ -96931,98 +105613,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; }; }; }; - /** - * List repository languages - * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. - */ "repos/list-languages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["language"]; }; }; }; }; - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/enable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; - /** - * @description We will return a 403 with one of the following messages: + /** @description We will return a 403 with one of the following messages: * - * - Git LFS support not enabled because Git LFS is globally disabled. - * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - * - Git LFS support not enabled because Git LFS is disabled for . - */ + * - Git LFS support not enabled because Git LFS is globally disabled. + * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + * - Git LFS support not enabled because Git LFS is disabled for . */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/disable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the license for a repository - * @description This method returns the contents of the repository's license file, if one is detected. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "licenses/get-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-content"]; }; @@ -97030,16 +105724,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Sync a fork branch with the upstream repository - * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. - */ "repos/merge-upstream": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97052,27 +105747,40 @@ export interface operations { responses: { /** @description The branch has been successfully synced with the upstream repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The branch could not be synced for some other reason */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Merge a branch */ "repos/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97089,30 +105797,38 @@ export interface operations { responses: { /** @description Successful Response (The resulting merge commit) */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when there is a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * List milestones - * @description Lists milestones for a repository. - */ "issues/list-milestones": { parameters: { query?: { @@ -97122,19 +105838,27 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"][]; @@ -97143,16 +105867,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a milestone - * @description Creates a milestone. - */ "issues/create-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97181,6 +105906,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"]; @@ -97190,21 +105916,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a milestone - * @description Gets a milestone using the given milestone number. - */ "issues/get-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; @@ -97212,34 +105944,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a milestone - * @description Deletes a milestone using the given milestone number. - */ "issues/delete-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** Update a milestone */ "issues/update-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97265,33 +106008,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; }; }; }; - /** - * List labels for issues in a milestone - * @description Lists labels for issues in a milestone. - */ "issues/list-labels-for-milestone": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -97299,30 +106050,38 @@ export interface operations { }; }; }; - /** - * List repository notifications for the authenticated user - * @description Lists all notifications for the current user in the specified repository. - */ "activity/list-repo-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -97330,16 +106089,17 @@ export interface operations { }; }; }; - /** - * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-repo-notifications-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97355,6 +106115,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -97364,26 +106127,32 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a GitHub Enterprise Server Pages site - * @description Gets information about a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -97391,97 +106160,109 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update information about a GitHub Enterprise Server Pages site - * @description Updates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-information-about-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.11/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @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. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: - | ("gh-pages" | "master" | "master /docs") - | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - }; + "application/json": + | { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.11/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @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. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: + | ("gh-pages" | "master" | "master /docs") + | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + } + | unknown + | unknown + | unknown + | unknown + | unknown; }; }; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["bad_request"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a GitHub Enterprise Server Pages site - * @description Configures a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } | null; + "application/json": + | ( + | { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } + | unknown + | unknown + ) + | null; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -97490,53 +106271,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a GitHub Enterprise Server Pages site - * @description Deletes a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List GitHub Enterprise Server Pages builds - * @description Lists builts of a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/list-pages-builds": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["page-build"][]; @@ -97544,85 +106328,93 @@ export interface operations { }; }; }; - /** - * Request a GitHub Enterprise Server Pages build - * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - */ "repos/request-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - /** - * Get latest Pages build - * @description Gets information about the single most recent build of a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-latest-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Get GitHub Enterprise Server Pages build - * @description Gets information about a GitHub Enterprise Server Pages build. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; build_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Create a GitHub Pages deployment - * @description Create a GitHub Pages deployment for a repository. - * - * The authenticated user must have write permission to the repository. - */ "repos/create-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97647,6 +106439,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-deployment"]; }; @@ -97656,84 +106451,106 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pre-receive hooks for a repository - * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. - */ "enterprise-admin/list-pre-receive-hooks-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "name"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"][]; }; }; }; }; - /** Get a pre-receive hook for a repository */ "enterprise-admin/get-pre-receive-hook-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * Remove pre-receive hook enforcement for a repository - * @description Deletes any overridden enforcement on this repository for the specified hook. - * - * Responds with effective values inherited from owner and/or global level. - */ "enterprise-admin/remove-pre-receive-hook-enforcement-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Responds with effective values inherited from owner and/or global level. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * Update pre-receive hook enforcement for a repository - * @description For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` - */ "enterprise-admin/update-pre-receive-hook-enforcement-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97749,34 +106566,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-repo": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -97789,16 +106613,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97813,6 +106638,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -97824,23 +106652,6 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List pull requests - * @description Lists pull requests in a specified repository. - * - * 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/enterprise-server@3.11/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list": { parameters: { query?: { @@ -97854,19 +106665,27 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -97876,27 +106695,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97934,6 +106743,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request"]; @@ -97943,38 +106753,35 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments-for-repo": { parameters: { query?: { sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -97982,28 +106789,27 @@ export interface operations { }; }; }; - /** - * Get a review comment for a pull request - * @description Provides details for a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; @@ -98011,44 +106817,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a review comment for a pull request - * @description Deletes a review comment. - */ "pulls/delete-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a review comment for a pull request - * @description Edits the content of a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -98061,16 +106868,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - /** - * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { @@ -98084,20 +106890,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -98106,17 +106921,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. - */ "reactions/create-for-pull-request-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -98140,12 +106957,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -98153,65 +106976,54 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.11/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/delete-for-pull-request-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Get a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists details of a pull request by providing its number. - * - * When you get, [create](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.11/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "pulls/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -98223,26 +107035,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98266,6 +107071,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -98274,39 +107082,38 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments on a pull request - * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -98314,31 +107121,19 @@ export interface operations { }; }; }; - /** - * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.11/rest/issues/comments#create-an-issue-comment)." - * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -98387,6 +107182,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -98396,28 +107192,21 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a reply for a review comment - * @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. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-reply-for-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -98433,6 +107222,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -98441,36 +107231,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.11/rest/commits/commits#list-commits) - * endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -98478,37 +107264,32 @@ export interface operations { }; }; }; - /** - * List pull requests files - * @description Lists the files in a specified pull request. - * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-files": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["diff-entry"][]; @@ -98519,41 +107300,51 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Check if a pull request has been merged - * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. - */ "pulls/check-if-merged": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if pull request has been merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if pull request has not been merged */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Merge a pull request - * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - */ "pulls/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98575,6 +107366,9 @@ export interface operations { responses: { /** @description if merge was successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-merge-result"]; }; @@ -98583,6 +107377,9 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ 405: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -98592,6 +107389,9 @@ export interface operations { }; /** @description Conflict if sha was provided and pull request head did not match */ 409: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -98602,23 +107402,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. - */ "pulls/list-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-request"]; @@ -98626,17 +107430,19 @@ export interface operations { }; }; }; - /** - * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - */ "pulls/request-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98651,6 +107457,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -98658,21 +107467,26 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove requested reviewers from a pull request - * @description Removes review requests from a pull request for a given set of users and/or teams. - */ "pulls/remove-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -98687,6 +107501,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -98694,34 +107511,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reviews for a pull request - * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-reviews": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The list of reviews returns in chronological order. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review"][]; @@ -98729,32 +107544,19 @@ export interface operations { }; }; }; - /** - * Create a review for a pull request - * @description Creates a review on a specified pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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/enterprise-server@3.11/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/pulls#get-a-pull-request) endpoint. - * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98791,6 +107593,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -98799,29 +107604,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a review for a pull request - * @description Retrieves a pull request review by its ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -98829,25 +107634,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a review for a pull request - * @description Updates the contents of a specified review summary comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -98860,6 +107661,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -98867,29 +107671,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete a pending review for a pull request - * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/delete-pending-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -98898,35 +107702,34 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List comments for a pull request review - * @description Lists comments for a specific pull request review. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-comments-for-review": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["review-comment"][]; @@ -98935,29 +107738,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Dismiss a review for a pull request - * @description Dismisses a specified review on a pull request. - * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.11/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/dismiss-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -98975,6 +107770,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -98983,25 +107781,21 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.11/rest/pulls/reviews#create-a-review-for-a-pull-request)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/submit-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -99019,6 +107813,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -99028,17 +107825,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Update a pull request branch - * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - */ "pulls/update-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99051,6 +107850,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -99062,29 +107864,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README - * @description Gets the preferred README for a repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -99093,31 +107894,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README for a directory - * @description Gets the README from a repository directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme-in-directory": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ dir: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -99126,28 +107926,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#list-repository-tags). - * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - */ "repos/list-releases": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"][]; @@ -99156,18 +107958,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a release - * @description Users with push access to the repository can create a release. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - */ "repos/create-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99210,6 +108011,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"]; @@ -99218,21 +108020,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. - */ "repos/get-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; @@ -99241,33 +108049,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a release asset */ "repos/delete-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release asset - * @description Users with push access to the repository can edit a release asset. - */ "repos/update-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99284,22 +108103,26 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; }; }; - /** - * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. - */ "repos/generate-release-notes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99318,6 +108141,9 @@ export interface operations { responses: { /** @description Name and body of generated release notes */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-notes-content"]; }; @@ -99325,44 +108151,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the latest release - * @description View the latest published full release for the repository. - * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - */ "repos/get-latest-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** - * Get a release by tag name - * @description Get a published release with the specified tag. - */ "repos/get-release-by-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description tag parameter */ tag: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; @@ -99370,65 +108204,78 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a release - * @description Gets a public release with the specified release ID. - * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - */ "repos/get-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a release - * @description Users with push access to the repository can delete a release. - */ "repos/delete-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release - * @description Users with push access to the repository can edit a release. - */ "repos/update-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99457,30 +108304,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** List release assets */ "repos/list-release-assets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release-asset"][]; @@ -99488,39 +108346,22 @@ export interface operations { }; }; }; - /** - * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#create-a-release) to upload a release asset. - * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - * - * `application/zip` - * - * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. - * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. - * - * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.11/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. - */ "repos/upload-release-asset": { parameters: { query: { name: string; label?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99530,39 +108371,50 @@ export interface operations { responses: { /** @description Response for successful upload */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). - */ "reactions/list-for-release": { parameters: { query?: { /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -99571,17 +108423,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. - */ "reactions/create-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -99597,12 +108451,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -99610,48 +108470,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.11/rest/releases/releases#get-a-release). - */ "reactions/delete-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository cache replication status - * @description Lists the status of each repository cache replica. - */ "repos/list-cache-info": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status information for cache replicas */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -99670,54 +108539,64 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get rules for a branch - * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply - * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level - * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" - * enforcement statuses are not returned. - */ "repos/get-branch-rules": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.11/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-rule-detailed"][]; }; }; }; }; - /** - * Get all repository rulesets - * @description Get all the rulesets for a repository. - */ "repos/get-repo-rulesets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"][]; }; @@ -99726,16 +108605,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a repository ruleset - * @description Create a ruleset for a repository. - */ "repos/create-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; /** @description Request body */ requestBody: { @@ -99760,6 +108640,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -99768,26 +108651,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get a repository ruleset - * @description Get a ruleset for a repository. - */ "repos/get-repo-ruleset": { parameters: { query?: { /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -99796,18 +108683,19 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update a repository ruleset - * @description Update a ruleset for a repository. - */ "repos/update-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; /** @description Request body */ requestBody?: { @@ -99832,6 +108720,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -99840,87 +108731,108 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete a repository ruleset - * @description Delete a ruleset for a repository. - */ "repos/delete-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List secret scanning alerts for a repository - * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.11/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a secret scanning alert - * @description Gets a single secret scanning alert detected in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; @@ -99928,26 +108840,27 @@ export interface operations { 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a secret scanning alert - * @description Updates the status of a secret scanning alert in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -99961,50 +108874,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description State does not match the resolution or resolution comment */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List locations for a secret scanning alert - * @description Lists all locations for a given secret scanning alert for an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-locations-for-alert": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["secret-scanning-location"][]; @@ -100012,35 +108938,38 @@ export interface operations { }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List stargazers - * @description Lists the people that have starred the repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-stargazers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -100051,20 +108980,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the weekly commit activity - * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - */ "repos/get-code-frequency-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -100073,20 +109007,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the last year of commit activity - * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. - */ "repos/get-commit-activity-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-activity"][]; }; @@ -100095,26 +109034,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get all contributor commit activity - * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits - */ "repos/get-contributors-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["contributor-activity"][]; }; @@ -100123,24 +109061,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the weekly commit count - * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - * - * The array order is oldest week (index 0) to most recent week. - * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. - */ "repos/get-participation-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The array order is oldest week (index 0) to most recent week. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["participation-stats"]; }; @@ -100148,26 +109087,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the hourly commit count for each day - * @description Each array contains the day number, hour number, and number of commits: - * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits - * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - */ "repos/get-punch-card-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -100175,19 +109113,18 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Create a commit status - * @description Users with push access in a repository can create commit statuses for a given SHA. - * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - */ "repos/create-commit-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; sha: string; }; + cookie?: never; }; requestBody: { content: { @@ -100197,11 +109134,9 @@ export interface operations { * @enum {string} */ state: "error" | "failure" | "pending" | "success"; - /** - * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. - * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: - * `http://ci.example.com/user/repo/build/sha` - */ + /** @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; /** @description A short description of the status. */ description?: string | null; @@ -100219,6 +109154,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"]; @@ -100226,26 +109162,30 @@ export interface operations { }; }; }; - /** - * List watchers - * @description Lists the people watching the specified repository. - */ "activity/list-watchers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -100253,20 +109193,25 @@ export interface operations { }; }; }; - /** - * Get a repository subscription - * @description Gets information about whether the authenticated user is subscribed to the repository. - */ "activity/get-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if you subscribe to the repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; @@ -100274,20 +109219,24 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#delete-a-repository-subscription) completely. - */ "activity/set-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -100302,47 +109251,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - /** - * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#set-a-repository-subscription). - */ "activity/delete-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List repository tags */ "repos/list-tags": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["tag"][]; @@ -100350,22 +109314,25 @@ export interface operations { }; }; }; - /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ "repos/list-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"][]; }; @@ -100374,17 +109341,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/create-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100397,6 +109364,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"]; }; @@ -100405,78 +109375,83 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/delete-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the tag protection. */ tag_protection_id: components["parameters"]["tag-protection-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Download a repository archive (tar) - * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. - */ "repos/download-tarball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * List repository teams - * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. - * - * For a public repository, a team is listed only if that team added the public repository explicitly. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. - */ "repos/list-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -100485,21 +109460,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get all repository topics */ "repos/get-all-topics": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -100507,13 +109491,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Replace all repository topics */ "repos/replace-all-topics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100526,6 +109514,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -100534,16 +109525,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.11/articles/about-repository-transfers/). - */ "repos/transfer": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100560,113 +109552,128 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - /** - * Check if vulnerability alerts are enabled for a repository - * @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/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/check-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if repository is enabled with vulnerability alerts */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not enabled with vulnerability alerts */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable vulnerability alerts - * @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/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/enable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable vulnerability alerts - * @description Disables dependency alerts 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/enterprise-server@3.11/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/disable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download a repository archive (zip) - * @description 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 - * 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. - */ "repos/download-zipball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.11/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-using-template": { parameters: { + query?: never; + header?: never; path: { /** @description The account owner of the template repository. The name is not case sensitive. */ template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ template_repo: string; }; + cookie?: never; }; requestBody: { content: { @@ -100696,6 +109703,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -100703,28 +109711,26 @@ export interface operations { }; }; }; - /** - * List public repositories - * @description Lists all public repositories in the order that they were created. - * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. - */ "repos/list-public": { parameters: { query?: { + /** @description A repository ID. Only return repositories with an ID greater than this ID. */ since?: components["parameters"]["since-repo"]; /** @description Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise. */ visibility?: "all" | "public"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -100734,30 +109740,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Lists provisioned SCIM groups in an enterprise. - * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. - */ "enterprise-admin/list-provisioned-groups-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either groups were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-list"]; }; @@ -100769,19 +109777,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Creates a SCIM group for an enterprise. - * - * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. - */ "enterprise-admin/provision-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -100791,6 +109795,9 @@ export interface operations { responses: { /** @description Group has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -100803,25 +109810,28 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Gets information about a SCIM group. - */ "enterprise-admin/get-provisioning-information-for-enterprise-group": { parameters: { query?: { + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; }; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a group was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -100834,20 +109844,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Replaces an existing provisioned group’s information. - * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. - */ "enterprise-admin/set-information-for-provisioned-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -100857,6 +109864,9 @@ export interface operations { responses: { /** @description Group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -100870,23 +109880,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Deletes a SCIM group from an enterprise. - */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Group was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -100896,22 +109909,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Update a provisioned group’s individual attributes. - * - * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. - * - * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. - */ "enterprise-admin/update-attribute-for-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -100921,13 +109929,19 @@ export interface operations { responses: { /** @description Success, group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; }; /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -100938,29 +109952,30 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Lists provisioned SCIM enterprise members. - * - * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. - */ "enterprise-admin/list-provisioned-identities-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either users were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-list"]; }; @@ -100972,21 +109987,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Creates an external identity for a new SCIM enterprise user. - * - * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. - * - * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. - */ "enterprise-admin/provision-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -100996,6 +110005,9 @@ export interface operations { responses: { /** @description User has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -101008,22 +110020,25 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Gets information about a SCIM user. - */ "enterprise-admin/get-provisioning-information-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a user was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -101036,22 +110051,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Replaces an existing provisioned user's information. - * - * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -101061,6 +110071,9 @@ export interface operations { responses: { /** @description User was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -101074,23 +110087,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. - */ "enterprise-admin/delete-user-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description User was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -101100,34 +110116,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Update a provisioned user's individual attributes. - * - * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). - * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` - */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -101137,6 +110136,9 @@ export interface operations { responses: { /** @description Success, user was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -101150,27 +110152,6 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). - * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: - * - * `q=addClass+in:file+language:js+repo:jquery/jquery` - * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. - * - * Considerations for code search: - * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: - * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - */ "search/code": { parameters: { query: { @@ -101180,13 +110161,22 @@ export interface operations { sort?: "indexed"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -101201,17 +110191,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). - * - * 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/enterprise-server@3.11/rest/search/search#text-match-metadata). - * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - * - * `q=repo:octocat/Spoon-Knife+css` - */ "search/commits": { parameters: { query: { @@ -101219,14 +110198,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -101238,21 +110227,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). - * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.11/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." - */ "search/issues-and-pull-requests": { parameters: { query: { @@ -101271,14 +110245,24 @@ export interface operations { | "interactions" | "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -101293,18 +110277,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). - * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - * - * `q=bug+defect+enhancement&repository_id=64778136` - * - * The labels that best match the query appear first in the search results. - */ "search/labels": { parameters: { query: { @@ -101314,14 +110286,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -101336,18 +110318,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). - * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: - * - * `q=tetris+language:assembly&sort=stars&order=desc` - * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - */ "search/repos": { parameters: { query: { @@ -101355,14 +110325,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -101376,30 +110356,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.11/articles/searching-topics/)" for a detailed list of qualifiers. - * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). - * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: - * - * `q=ruby+is:featured` - * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - */ "search/topics": { parameters: { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.11/rest/search/search#constructing-a-search-query). */ q: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -101411,20 +110388,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.11/rest/search/search#text-match-metadata). - * - * For example, if you're looking for a list of popular users, you might try this query: - * - * `q=tom+repos:%3E42+followers:%3E1000` - * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.11/graphql/reference/queries#search)." - */ "search/users": { parameters: { query: { @@ -101432,14 +110395,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.11/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -101453,84 +110426,100 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get the configuration status - * @description This endpoint allows you to check the status of the most recent configuration process: - * - * Note that you may need to wait several seconds after you start a process before you can check its status. - * - * The different statuses are: - * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | - */ "enterprise-admin/get-configuration-status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["configuration-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Start a configuration process - * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: - */ "enterprise-admin/start-configuration-process": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the maintenance status - * @description Check your installation's maintenance status: - */ "enterprise-admin/get-maintenance-status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["maintenance-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/enable-or-disable-maintenance-mode": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { - /** - * @description A JSON string with the attributes `enabled` and `when`. + /** @description A JSON string with the attributes `enabled` and `when`. * - * The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. + * The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). */ maintenance: string; }; }; @@ -101538,46 +110527,56 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["maintenance-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#set-settings). - * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. - */ "enterprise-admin/get-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-settings"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#get-settings). - * - * **Notes:** - * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.11/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." - */ "enterprise-admin/set-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -101589,34 +110588,54 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Get all authorized SSH keys */ "enterprise-admin/get-all-authorized-ssh-keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/add-authorized-ssh-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -101628,21 +110647,29 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/remove-authorized-ssh-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -101654,30 +110681,29 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; - }; - }; - }; - /** - * Create a GitHub license - * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. - * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.11/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. - * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: - * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "enterprise-admin/create-enterprise-server-license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "multipart/form-data": { @@ -101693,21 +110719,27 @@ export interface operations { responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Upgrade a license - * @description This API upgrades your license and also triggers the configuration process. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ "enterprise-admin/upgrade-license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "multipart/form-data": { @@ -101719,28 +110751,37 @@ export interface operations { responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#get-a-team-by-name) endpoint. - */ "teams/get-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -101748,44 +110789,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#delete-a-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - */ "teams/delete-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#update-a-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - */ "teams/update-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -101796,18 +110831,18 @@ export interface operations { description?: string; /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -101827,12 +110862,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -101842,31 +110883,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -101874,22 +110914,15 @@ export interface operations { }; }; }; - /** - * Create a discussion (Legacy) - * @deprecated - * @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/enterprise-server@3.11/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -101909,75 +110942,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -101992,38 +111024,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -102031,23 +111066,17 @@ export interface operations { }; }; }; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @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/enterprise-server@3.11/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.11/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.11/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.11/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -102060,78 +111089,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -102144,21 +111175,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { @@ -102172,20 +111197,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -102193,24 +111227,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.11/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -102234,21 +111263,15 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { @@ -102262,19 +111285,27 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -102282,23 +111313,17 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.11/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.11/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -102322,36 +111347,39 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List team members (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.11/rest/teams/members#list-team-members) endpoint. - * - * Team members will include the members of child teams. - */ "teams/list-members-legacy": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -102360,126 +111388,123 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get team member (Legacy) - * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/get-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if user is not a member */ 404: { - content: never; - }; - }; - }; - /** - * Add team member (Legacy) - * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ 422: { - content: never; - }; - }; - }; - /** - * Remove team member (Legacy) - * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/remove-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team synchronization is setup */ 404: { - content: never; - }; - }; - }; - /** - * Get team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#get-team-membership-for-a-user) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#create-a-team). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/get-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; @@ -102487,27 +111512,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add or update team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If 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. - */ "teams/add-or-update-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102524,72 +111539,82 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.11/rest/teams/members#remove-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.11/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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.11/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ "teams/remove-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ "teams/list-projects-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -102598,46 +111623,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - */ "teams/check-permissions-for-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - */ "teams/add-or-update-project-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102653,10 +111681,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -102668,49 +111702,53 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - */ "teams/remove-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List team repositories (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-team-repositories) endpoint. - */ "teams/list-repos-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -102719,56 +111757,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a repository (Legacy) - * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.11/rest/overview/media-types/) via the `Accept` header: - */ "teams/check-permissions-for-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with extra repository information */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions (Legacy) - * @deprecated - * @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/enterprise-server@3.11/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. - * - * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "teams/add-or-update-repo-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102784,54 +111826,62 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#remove-a-repository-from-a-team) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - */ "teams/remove-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.11/rest/teams/teams#list-child-teams) endpoint. - */ "teams/list-child-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -102842,14 +111892,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. - */ "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -102861,11 +111917,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Update the authenticated user - * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. - */ "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -102909,6 +111967,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["private-user"]; }; @@ -102920,41 +111981,45 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get list of conflicting packages during Docker migration for authenticated-user - * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; }; }; }; - /** - * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible - * to the public. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -102966,11 +112031,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -102985,6 +112052,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["email"][]; }; @@ -102996,11 +112066,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -103012,7 +112084,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103021,22 +112096,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List followers of the authenticated user - * @description Lists the people following the authenticated user. - */ "users/list-followers-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -103047,22 +112125,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List the people the authenticated user follows - * @description Lists the people who the authenticated user follows. - */ "users/list-followed-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -103073,45 +112154,57 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Check if a person is followed by the authenticated user */ "users/check-person-is-followed-by-authenticated": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the person is followed by the authenticated user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/follow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103119,20 +112212,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unfollow a user - * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/unfollow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103140,24 +112237,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -103169,13 +112267,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -103189,6 +112287,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -103200,21 +112301,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/get-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -103225,22 +112328,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. - */ "users/delete-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103249,26 +112354,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List app installations accessible to the user access token - * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You can find the permissions for the installation under the `permissions` key. - */ "apps/list-installations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -103282,29 +112386,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories accessible to the user access token - * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * The access the user has to each repository is included in the hash under the `permissions` key. - */ "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -103319,68 +112422,65 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add a repository to an app installation - * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */ 422: { - content: never; - }; - }; - }; - /** - * List user account issues assigned to the authenticated user - * @description 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 - * 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/enterprise-server@3.11/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list-for-authenticated-user": { parameters: { query?: { @@ -103394,20 +112494,30 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -103417,24 +112527,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key"][]; @@ -103446,13 +112557,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -103469,6 +112580,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -103480,21 +112594,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/get-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -103505,22 +112621,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. - */ "users/delete-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -103528,24 +112646,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization memberships for the authenticated user - * @description Lists all of the authenticated user's organization memberships. - */ "orgs/list-memberships-for-authenticated-user": { parameters: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-membership"][]; @@ -103557,19 +112678,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization membership for the authenticated user - * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. - */ "orgs/get-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -103578,15 +112703,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization membership for the authenticated user - * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. - */ "orgs/update-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -103602,6 +112727,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -103611,22 +112739,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List user migrations - * @description Lists all migrations a user has started. - */ "migrations/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -103637,11 +112768,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Start a user migration - * @description Initiates the generation of a user migration archive. - */ "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -103684,8 +112817,8 @@ export interface operations { /** * @description Exclude attributes from the API response to improve performance * @example [ - * "repositories" - * ] + * "repositories" + * ] */ exclude?: "repositories"[]; repositories: string[]; @@ -103695,6 +112828,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -103705,65 +112841,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Download a user migration archive - * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - */ "migrations/get-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories for a user migration - * @description Lists all the repositories for this user migration. - */ "migrations/list-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -103772,24 +112895,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organizations for the authenticated user - * @description List organizations for the authenticated user. - * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. - */ "orgs/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -103800,12 +112924,6 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List packages for the authenticated user's namespace - * @description Lists packages owned by the authenticated user within the user's namespace. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-authenticated-user": { parameters: { query: { @@ -103817,14 +112935,27 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -103832,104 +112963,112 @@ export interface operations { 400: components["responses"]["package_es_list_error"]; }; }; - /** - * Get a package for the authenticated user - * @description Gets a specific package for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for the authenticated user - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for the authenticated user - * @description Restores a package owned by the authenticated user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-authenticated-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by the authenticated user - * @description Lists package versions for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -103939,88 +113078,96 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for the authenticated user - * @description Gets a specific package version for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete a package version for the authenticated user - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package version for the authenticated user - * @description Restores a package version owned by the authenticated user. - * - * You can restore a deleted package version under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -104040,6 +113187,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -104050,26 +113200,25 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-public-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -104081,23 +113230,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories for the authenticated user - * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - */ "repos/list-for-authenticated-user": { parameters: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "public" | "private"; - /** - * @description Comma-separated list of values. Can include: - * * `owner`: Repositories that are owned by the authenticated user. - * * `collaborator`: Repositories that the user has been added to as a collaborator. - * * `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: + * * `owner`: Repositories that are owned by the authenticated user. + * * `collaborator`: Repositories that the user has been added to as a collaborator. + * * `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. */ affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ type?: "all" | "owner" | "public" | "private" | "member"; @@ -104105,15 +113246,26 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; + /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before-repo-date"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository"][]; }; @@ -104124,13 +113276,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a repository for the authenticated user - * @description Creates a new repository for the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -104222,34 +113374,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -104274,6 +113426,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -104287,22 +113440,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository invitations for the authenticated user - * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. - */ "repos/list-invitations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -104314,17 +113470,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Decline a repository invitation */ "repos/decline-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -104332,17 +113495,24 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** Accept a repository invitation */ "repos/accept-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -104350,22 +113520,25 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List social accounts for the authenticated user - * @description Lists all of your social accounts. - */ "users/list-social-accounts-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -104377,13 +113550,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -104398,6 +113571,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["social-account"][]; }; @@ -104409,13 +113585,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -104430,7 +113606,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -104439,24 +113618,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/list-ssh-signing-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -104468,13 +113648,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. - */ "users/create-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -104491,6 +113671,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -104502,21 +113685,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/get-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -104527,22 +113712,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. - */ "users/delete-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -104550,28 +113737,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories starred by the authenticated user - * @description Lists repositories the authenticated user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-authenticated-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository"][]; @@ -104583,48 +113771,61 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Check if a repository is starred by the authenticated user - * @description Whether the authenticated user has starred the repository. - */ "activity/check-repo-is-starred-by-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if this repository is starred by you */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description Not Found if this repository is not starred by you */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "activity/star-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -104632,21 +113833,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unstar a repository for the authenticated user - * @description Unstar a repository that the authenticated user has previously starred. - */ "activity/unstar-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -104654,22 +113860,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories watched by the authenticated user - * @description Lists repositories the authenticated user is watching. - */ "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -104680,27 +113889,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. - * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. - * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. - */ "teams/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-full"][]; @@ -104711,25 +113918,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List users - * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.11/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. - */ "users/list": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -104738,23 +113946,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a user - * @description Provides publicly available information about someone with a GitHub account. - * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#authentication). - * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.11/rest/users/emails)". - */ "users/get-by-username": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -104764,21 +113972,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get list of conflicting packages during Docker migration for user - * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -104787,92 +113997,114 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - */ "activity/list-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List organization events for the authenticated user - * @description This is the user's organization dashboard. You must be authenticated as the user to view this. - */ "activity/list-org-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events for a user */ "activity/list-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List followers of a user - * @description Lists the people following the specified user. - */ "users/list-followers-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -104880,25 +114112,28 @@ export interface operations { }; }; }; - /** - * List the people a user follows - * @description Lists the people who the specified user follows. - */ "users/list-following-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -104906,45 +114141,59 @@ export interface operations { }; }; }; - /** Check if a user follows another user */ "users/check-following-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; target_user: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the user follows the target user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if the user does not follow the target user */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List gists for a user - * @description Lists public gists for the specified user: - */ "gists/list-for-user": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -104953,25 +114202,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List GPG keys for a user - * @description Lists the GPG keys for a user. This information is accessible by anyone. - */ "users/list-gpg-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -104979,14 +114231,6 @@ export interface operations { }; }; }; - /** - * Get contextual information for a user - * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "users/get-context-for-user": { parameters: { query?: { @@ -104995,13 +114239,20 @@ export interface operations { /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ subject_id?: string; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hovercard"]; }; @@ -105010,46 +114261,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user installation for the authenticated app - * @description Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.11/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-user-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List public keys for a user - * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - */ "users/list-public-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key-simple"][]; @@ -105057,27 +114313,28 @@ export interface operations { }; }; }; - /** - * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.11/articles/publicizing-or-concealing-organization-membership) for the specified user. - * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. - */ "orgs/list-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -105085,12 +114342,6 @@ export interface operations { }; }; }; - /** - * List packages for a user - * @description Lists all packages in a user's namespace for which the requesting user has access. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-user": { parameters: { query: { @@ -105102,17 +114353,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -105122,106 +114386,113 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for a user - * @description Gets a specific package metadata for a public package owned by a user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for a user - * @description Restores an entire package for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by a user - * @description Lists package versions for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -105231,109 +114502,119 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for a user - * @description Gets a specific package version for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for a user - * @description Restores a specific package version for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.11/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List user projects - * @description Lists projects for a user. - */ "projects/list-for-user": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -105342,53 +114623,62 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. - */ "activity/list-received-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events received by a user */ "activity/list-received-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List repositories for a user - * @description Lists public repositories for the specified user. - */ "repos/list-for-user": { parameters: { query?: { @@ -105398,18 +114688,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -105417,59 +114714,70 @@ export interface operations { }; }; }; - /** - * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "enterprise-admin/promote-user-to-be-site-administrator": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Demote a site administrator - * @description You can demote any user account except your own. - */ "enterprise-admin/demote-site-administrator": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List social accounts for a user - * @description Lists social media accounts for a user. This endpoint is accessible by anyone. - */ "users/list-social-accounts-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -105477,25 +114785,28 @@ export interface operations { }; }; }; - /** - * List SSH signing keys for a user - * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. - */ "users/list-ssh-signing-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -105503,31 +114814,32 @@ export interface operations { }; }; }; - /** - * List repositories starred by a user - * @description Lists repositories a user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -105537,25 +114849,28 @@ export interface operations { }; }; }; - /** - * List repositories watched by a user - * @description Lists repositories a user is watching. - */ "activity/list-repos-watched-by-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -105563,19 +114878,15 @@ export interface operations { }; }; }; - /** - * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. - * - * You can suspend any user account except your own. - * - * 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 method](https://docs.github.com/enterprise-server@3.11/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "enterprise-admin/suspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -105588,19 +114899,22 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.11/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. - */ "enterprise-admin/unsuspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -105613,83 +114927,59 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the Zen of GitHub - * @description Get a random sentence from the Zen of GitHub - */ "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string; }; }; }; }; - /** - * Compare two commits - * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. - * - * 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. - * - * 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, 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)." - * - * 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 following fields are included in the `verification` object: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; base: string; head: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; diff --git a/packages/openapi-types-ghes-3.9/types.d.ts b/packages/openapi-types-ghes-3.9/types.d.ts index 5c4a57192..eb40d13c6 100644 --- a/packages/openapi-types-ghes-3.9/types.d.ts +++ b/packages/openapi-types-ghes-3.9/types.d.ts @@ -3,350 +3,813 @@ * Do not make direct changes to the file. */ -/** OneOf type helpers */ -type Without = { [P in Exclude]?: never }; -type XOR = T | U extends object - ? (Without & U) | (Without & T) - : T | U; -type OneOf = T extends [infer Only] - ? Only - : T extends [infer A, infer B, ...infer Rest] - ? OneOf<[XOR, ...Rest]> - : never; - export interface paths { "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List global webhooks */ get: operations["enterprise-admin/list-global-webhooks"]; + put?: never; /** Create a global webhook */ post: operations["enterprise-admin/create-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a global webhook */ get: operations["enterprise-admin/get-global-webhook"]; + put?: never; + post?: never; /** Delete a global webhook */ delete: operations["enterprise-admin/delete-global-webhook"]; + options?: never; + head?: never; /** * Update a global webhook * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. */ patch: operations["enterprise-admin/update-global-webhook"]; + trace?: never; }; "/admin/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a global webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook. */ post: operations["enterprise-admin/ping-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public keys */ get: operations["enterprise-admin/list-public-keys"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys/{key_ids}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a public key */ delete: operations["enterprise-admin/delete-public-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/ldap/teams/{team_id}/mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update LDAP mapping for a team * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. */ patch: operations["enterprise-admin/update-ldap-mapping-for-team"]; + trace?: never; }; "/admin/ldap/teams/{team_id}/sync": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync LDAP mapping for a team * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. */ post: operations["enterprise-admin/sync-ldap-mapping-for-team"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/ldap/users/{username}/mapping": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** Update LDAP mapping for a user */ patch: operations["enterprise-admin/update-ldap-mapping-for-user"]; + trace?: never; }; "/admin/ldap/users/{username}/sync": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync LDAP mapping for a user * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. */ post: operations["enterprise-admin/sync-ldap-mapping-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an organization */ post: operations["enterprise-admin/create-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** Update an organization name */ patch: operations["enterprise-admin/update-org-name"]; + trace?: never; }; "/admin/pre-receive-environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List pre-receive environments */ get: operations["enterprise-admin/list-pre-receive-environments"]; + put?: never; /** Create a pre-receive environment */ post: operations["enterprise-admin/create-pre-receive-environment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive environment */ get: operations["enterprise-admin/get-pre-receive-environment"]; + put?: never; + post?: never; /** * Delete a pre-receive environment * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Cannot delete environment that has hooks_ + * * _Cannot delete environment when download is in progress_ */ delete: operations["enterprise-admin/delete-pre-receive-environment"]; + options?: never; + head?: never; /** * Update a pre-receive environment * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. */ patch: operations["enterprise-admin/update-pre-receive-environment"]; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a pre-receive environment download * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. + * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Can not start a new download when a download is in progress_ */ post: operations["enterprise-admin/start-pre-receive-environment-download"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the download status for a pre-receive environment * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. */ get: operations["enterprise-admin/get-download-status-for-pre-receive-environment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List pre-receive hooks */ get: operations["enterprise-admin/list-pre-receive-hooks"]; + put?: never; /** Create a pre-receive hook */ post: operations["enterprise-admin/create-pre-receive-hook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook */ get: operations["enterprise-admin/get-pre-receive-hook"]; + put?: never; + post?: never; /** Delete a pre-receive hook */ delete: operations["enterprise-admin/delete-pre-receive-hook"]; + options?: never; + head?: never; /** Update a pre-receive hook */ patch: operations["enterprise-admin/update-pre-receive-hook"]; + trace?: never; }; "/admin/tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List personal access tokens * @description Lists personal access tokens for all users, including admin users. */ get: operations["enterprise-admin/list-personal-access-tokens"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/tokens/{token_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a personal access token * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. */ delete: operations["enterprise-admin/delete-personal-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. * - * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. + * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. * - * If the login name or email address is already associated with an account, the server will return a `422` response. + * If the login name or email address is already associated with an account, the server will return a `422` response. */ post: operations["enterprise-admin/create-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a user * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user) is often a better option. * - * You can delete any user account except your own. + * You can delete any user account except your own. */ delete: operations["enterprise-admin/delete-user"]; + options?: never; + head?: never; /** Update the username for a user */ patch: operations["enterprise-admin/update-username-for-user"]; + trace?: never; }; "/admin/users/{username}/authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an impersonation OAuth token */ post: operations["enterprise-admin/create-impersonation-o-auth-token"]; /** Delete an impersonation OAuth token */ delete: operations["enterprise-admin/delete-impersonation-o-auth-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated app * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installations for the authenticated app * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * - * The permissions the installation has are included under the `permissions` key. + * The permissions the installation has are included under the `permissions` key. */ get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. + * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/grants": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List your grants * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. */ get: operations["oauth-authorizations/list-grants"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/grants/{grant_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a single grant * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/get-grant"]; + put?: never; + post?: never; /** * Delete a grant * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["oauth-authorizations/delete-grant"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. @@ -357,742 +820,1488 @@ export interface paths { * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. */ delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; + trace?: never; }; "/applications/{client_id}/token/scoped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a scoped access token * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. + * which repositories the token can access and which permissions are granted to the + * token. * - * Invalid tokens will return `404 NOT FOUND`. + * Invalid tokens will return `404 NOT FOUND`. * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. + * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ post: operations["apps/scope-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List your authorizations * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/list-authorizations"]; + put?: never; /** * Create a new authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. * - * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use). + * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.9/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.9/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ post: operations["oauth-authorizations/create-authorization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/clients/{client_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Get-or-create an authorization for a specific app * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ put: operations["oauth-authorizations/get-or-create-authorization-for-app"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/clients/{client_id}/{fingerprint}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Get-or-create an authorization for a specific app and fingerprint * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." */ put: operations["oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/authorizations/{authorization_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a single authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ get: operations["oauth-authorizations/get-authorization"]; + put?: never; + post?: never; /** * Delete an authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). */ delete: operations["oauth-authorizations/delete-authorization"]; + options?: never; + head?: never; /** * Update an existing authorization * @deprecated * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." * - * You can only send one of these scope keys at a time. + * You can only send one of these scope keys at a time. */ patch: operations["oauth-authorizations/update-authorization"]; + trace?: never; }; "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get emojis * @description Lists all the emojis available to use on GitHub Enterprise Server. */ get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the global announcement banner * @description Gets the current message and expiration date of the global announcement banner in your enterprise. */ get: operations["enterprise-admin/get-announcement"]; + put?: never; + post?: never; /** * Remove the global announcement banner * @description Removes the global announcement banner in your enterprise. */ delete: operations["enterprise-admin/remove-announcement"]; + options?: never; + head?: never; /** * Set the global announcement banner * @description Sets the message and expiration time for the global announcement banner in your enterprise. */ patch: operations["enterprise-admin/set-announcement"]; + trace?: never; }; "/enterprise/settings/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get license information */ get: operations["enterprise-admin/get-license-information"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/all": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all statistics */ get: operations["enterprise-admin/get-all-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get comment statistics */ get: operations["enterprise-admin/get-comment-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get gist statistics */ get: operations["enterprise-admin/get-gist-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get hooks statistics */ get: operations["enterprise-admin/get-hooks-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get issue statistics */ get: operations["enterprise-admin/get-issue-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get milestone statistics */ get: operations["enterprise-admin/get-milestone-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get organization statistics */ get: operations["enterprise-admin/get-org-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pages statistics */ get: operations["enterprise-admin/get-pages-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pull request statistics */ get: operations["enterprise-admin/get-pull-request-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get repository statistics */ get: operations["enterprise-admin/get-repo-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get users statistics */ get: operations["enterprise-admin/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an enterprise * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/cache/usage-policy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage policy for an enterprise * @description Gets the GitHub Actions cache usage policy for an enterprise. * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-policy-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set GitHub Actions cache usage policy for an enterprise * @description Sets the GitHub Actions cache usage policy for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ patch: operations["actions/set-actions-cache-usage-policy-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an enterprise * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; /** * Set GitHub Actions permissions for an enterprise * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; /** * Set selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected organization for GitHub Actions in an enterprise * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + post?: never; /** * Disable a selected organization for GitHub Actions in an enterprise * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an enterprise * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-allowed-actions-enterprise"]; /** * Set allowed actions for an enterprise * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-allowed-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an enterprise * @description 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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-enterprise"]; /** * Set default workflow permissions for an enterprise * @description 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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + * 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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an enterprise * @description Lists all self-hosted runner groups for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + put?: never; /** * Create a self-hosted runner group for an enterprise * @description Creates a new self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an enterprise * @description Gets a specific self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an enterprise * @description Deletes a self-hosted runner group for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an enterprise * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization access to a self-hosted runner group in an enterprise * @description Lists the organizations with access to a self-hosted runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise"]; /** * Set organization access for a self-hosted runner group in an enterprise * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add organization access to a self-hosted runner group in an enterprise * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise"]; + post?: never; /** * Remove organization access to a self-hosted runner group in an enterprise * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an enterprise * @description Lists the self-hosted runners that are in a specific enterprise group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Set self-hosted runners in a group for an enterprise * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an enterprise * @description Adds a self-hosted runner to a runner group configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + post?: never; /** * Remove a self-hosted runner from a group for an enterprise * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an enterprise * @description Lists all self-hosted runners configured for an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an enterprise * @description Lists binaries for the runner application that you can download and run. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an enterprise * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * Example using registration token: + * Example using registration token: * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-registration-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an enterprise * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * Example using remove token: + * Example using remove token: * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-remove-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an enterprise * @description Gets a specific self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an enterprise * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an enterprise * @description Lists all labels for a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise"]; /** * Set custom labels for a self-hosted runner for an enterprise * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. + * self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise"]; /** * Add custom labels to a self-hosted runner for an enterprise * @description Add custom labels to a self-hosted runner configured in an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise"]; /** * Remove all custom labels from a self-hosted runner for an enterprise * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. + * enterprise. Returns the remaining read-only labels from the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an enterprise * @description Remove a custom label from a self-hosted runner configured - * in an enterprise. Returns the remaining labels from the runner. + * 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an enterprise * @description Gets the audit log for an enterprise. * - * The authenticated user must be an enterprise admin to use this endpoint. + * The authenticated user must be an enterprise admin to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an enterprise * @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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. */ get: operations["code-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/code_security_and_analysis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get code security and analysis features for an enterprise * @description Gets code security and analysis settings for the specified enterprise. * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. + * The authenticated user must be an administrator of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ get: operations["secret-scanning/get-security-analysis-settings-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update code security and analysis features for an enterprise * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ patch: operations["secret-scanning/patch-security-analysis-settings-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * 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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * 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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ get: operations["dependabot/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an enterprise * @description 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/enterprise-server@3.9/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. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ get: operations["secret-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an enterprise * @description 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-ghe"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature * @description Enables or disables the specified security feature for all repositories in an enterprise. * - * The authenticated user must be an administrator of the enterprise to use this endpoint. + * The authenticated user must be an administrator of the enterprise to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ post: operations["secret-scanning/post-security-product-enablement-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public events * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ get: operations["activity/list-public-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get feeds * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * - * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. + * * **Timeline**: The GitHub Enterprise Server global public timeline + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List starred gists * @description List the authenticated user's starred gists: */ get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @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. */ patch: operations["gists/update"]; + trace?: never; }; "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update-comment"]; + trace?: never; }; "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist commits */ get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist forks */ get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a gist is starred */ get: operations["gists/check-is-starred"]; /** @@ -1100,132 +2309,338 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; + post?: never; /** Unstar a gist */ delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. */ get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issues assigned to the authenticated user * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/config/nodes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GHES node metadata for all nodes * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering)." */ get: operations["enterprise-admin/get-config-nodes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/replication/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the status of services running on all replica nodes * @description Gets the status of all services running on each replica node. - * This endpoint may take several seconds to reply. + * This endpoint may take several seconds to reply. */ get: operations["enterprise-admin/get-replication-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/manage/v1/version": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all GHES release versions for all nodes * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.9/admin/all-releases)." */ get: operations["enterprise-admin/get-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Render a Markdown document */ post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get GitHub Enterprise Server meta information */ get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/networks/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a network of repositories */ get: operations["activity/list-public-events-for-repo-network"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. @@ -1236,192 +2651,327 @@ export interface paths { * @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 Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. */ patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread subscription for the authenticated user * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription). * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Octocat * @description Get the octocat as ASCII art */ get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations/{organization_id}/custom_roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Deprecated - List custom repository roles in an organization * @deprecated * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-roles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/). * - * To see the full details about an organization, the authenticated user must be an organization owner. + * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * - * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. + * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. */ get: operations["orgs/get"]; + put?: never; + post?: never; /** * Delete an organization * @description Deletes an organization and all its repositories. * - * The organization login will be unavailable for 90 days after deletion. + * The organization login will be unavailable for 90 days after deletion. * - * Please review the Terms of Service regarding account deletion before using this endpoint: + * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; + options?: never; + head?: never; /** * Update an organization * @description **Parameter Deprecation Notice:** GitHub Enterprise Server 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). * - * Updates the organization's profile and member privileges. + * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ patch: operations["orgs/update"]; + trace?: never; }; "/orgs/{org}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an organization * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/cache/usage-by-repository": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["oidc/update-oidc-custom-sub-template-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories enabled for GitHub Actions in an organization * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** @@ -1429,1042 +2979,1693 @@ export interface paths { * @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)." * * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an organization * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions for an organization * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an organization * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; /** * Create a self-hosted runner group for an organization * @description Creates a new self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an organization * @description Gets a specific self-hosted runner group for an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an organization * @description Deletes a self-hosted runner group for an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an organization * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository access to a self-hosted runner group in an organization * @description Lists the repositories with access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-repo-access-to-self-hosted-runner-group-in-org"]; /** * Set repository access for a self-hosted runner group in an organization * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add repository access to a self-hosted runner group in an organization * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; + post?: never; /** * Remove repository access to a self-hosted runner group in an organization * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an organization * @description Lists self-hosted runners that are in a specific organization group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-in-group-for-org"]; /** * Set self-hosted runners in a group for an organization * @description Replaces the list of self-hosted runners that are part of an organization runner group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an organization * @description Adds a self-hosted runner to a runner group configured in an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; /** * Remove a self-hosted runner from a group for an organization * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** * Set custom labels for a self-hosted runner for an organization * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. + * self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization * @description Adds custom labels to a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** * Remove all custom labels from a self-hosted runner for an organization * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. + * organization. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an organization * @description Remove a custom label from a self-hosted runner configured - * in an organization. Returns the remaining labels from the runner. + * in an organization. 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * The authenticated user must have collaborator access to a repository to create, update, or read secrets * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to + * use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. For more information about setting the visibility, see [Create or + * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization variables * @description Lists all organization variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-variables"]; + put?: never; /** * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-org-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization variable * @description Gets a specific variable in an organization. * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-variable"]; + put?: never; + post?: never; /** * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-variable"]; + options?: never; + head?: never; /** * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ patch: operations["actions/update-org-variable"]; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization variable * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. + * that is available to selected repositories. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-variable"]; /** * Set selected repositories for an organization variable * @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`. + * to selected repositories. Organization variables that are available to selected + * repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-variable"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization variable * @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`. + * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-variable"]; + post?: never; /** * Remove selected repository from an organization variable * @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`. + * available to selected repositories. Organization variables that are available to + * selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-variable"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get announcement banner for organization * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. + * organization level. Organization members may also see an enterprise-level announcement banner. To get an + * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. */ get: operations["announcement-banners/get-announcement-banner-for-org"]; + put?: never; + post?: never; /** * Remove announcement banner from organization * @description Removes the announcement banner currently set for the organization. */ delete: operations["announcement-banners/remove-announcement-banner-for-org"]; + options?: never; + head?: never; /** * Set announcement banner for organization * @description Sets the announcement banner to display for the organization. */ patch: operations["announcement-banners/set-announcement-banner-for-org"]; + trace?: never; }; "/orgs/{org}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an organization * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. */ get: operations["orgs/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom repository roles in an organization * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-custom-repo-roles"]; + put?: never; /** * Create a custom repository role * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-repo-role"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/custom-repository-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom repository role * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/get-custom-repo-role"]; + put?: never; + post?: never; /** * Delete a custom repository role * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-repo-role"]; + options?: never; + head?: never; /** * Update a custom repository role * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/update-custom-repo-role"]; + trace?: never; }; "/orgs/{org}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization + * permission to use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["dependabot/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public organization events */ get: operations["activity/list-public-org-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-group/{group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization webhooks * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description Create a hook that posts payloads in JSON format. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization webhook * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** * Delete an organization webhook * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping an organization webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) - * to be sent to the hook. + * to be sent to the hook. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations for an organization * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. + * all GitHub Apps installed on repositories in the organization. * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. @@ -2474,223 +4675,447 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * - * **Rate limits** + * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization migrations * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). * - * A list of `repositories` is only returned for export migrations. + * A list of `repositories` is only returned for export migrations. */ get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. * - * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization migration status * @description Fetches the status of a migration. * - * The `state` of a migration can be one of the following values: + * The `state` of a migration can be one of the following values: * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Convert an organization member to outside collaborator * @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/enterprise-server@3.9/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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; + put?: never; + post?: never; /** * Delete a package for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for an organization * @description Restores an entire package in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; + put?: never; + post?: never; /** * Delete package version for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for an organization * @description Restores a specific package version in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pre-receive hooks for an organization * @description List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. */ get: operations["enterprise-admin/list-pre-receive-hooks-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook for an organization */ get: operations["enterprise-admin/get-pre-receive-hook-for-org"]; + put?: never; + post?: never; /** * Remove pre-receive hook enforcement for an organization * @description Removes any overrides for this hook at the org level for this org. */ delete: operations["enterprise-admin/remove-pre-receive-hook-enforcement-for-org"]; + options?: never; + head?: never; /** * Update pre-receive hook enforcement for an organization * @description For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration` */ patch: operations["enterprise-admin/update-pre-receive-hook-enforcement-for-org"]; + trace?: never; }; "/orgs/{org}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-org"]; + put?: never; /** * Create an organization project * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. */ get: operations["orgs/list-public-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check public organization membership for a user * @description Check if the provided user is a public member of the organization. @@ -2700,1376 +5125,2516 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; + post?: never; /** * Remove public organization membership for the authenticated user * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization repositories * @description 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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repository-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository fine-grained permissions for an organization * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. + * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ get: operations["orgs/list-repo-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List security manager teams * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-security-manager-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a security manager team * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["orgs/add-security-manager-team"]; + post?: never; /** * Remove a security manager team * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-security-manager-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/advanced-security": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Advanced Security active committers for an organization * @description 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. + * 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. + * 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. + * The total number of repositories with committer information is tracked by the `total_count` field. */ get: operations["billing/get-github-advanced-security-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ get: operations["teams/list"]; + put?: never; /** * Create a team * @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/enterprise-server@3.9/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/enterprise-server@3.9/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/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-in-org"]; + put?: never; /** * Create a discussion * @description Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-in-org"]; + put?: never; + post?: never; /** * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-in-org"]; + options?: never; + head?: never; /** * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-in-org"]; + put?: never; /** * Create a discussion comment * @description Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * **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`. + * **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`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-in-org"]; + put?: never; + post?: never; /** * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-in-org"]; + options?: never; + head?: never; /** * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; + put?: never; /** * Create reaction for a team discussion comment * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; + put?: never; /** * Create reaction for a team discussion * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List a connection between an external group and a team * @description Lists a connection between a team and an external group. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-linked-external-idp-groups-to-team-for-org"]; + put?: never; + post?: never; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + options?: never; + head?: never; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members * @description Team members will include the members of child teams. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user * @description Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/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. + * 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. * - * If 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. + * If 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. * - * **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}`. + * **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}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @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. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/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}`. + * **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}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; + post?: never; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **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}`. + * **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/enterprise-server@3.9/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/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature for an organization * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/cards/{card_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project card * @description Gets information about a project card. */ get: operations["projects/get-card"]; + put?: never; + post?: never; /** * Delete a project card * @description Deletes a project card */ delete: operations["projects/delete-card"]; + options?: never; + head?: never; /** Update an existing project card */ patch: operations["projects/update-card"]; + trace?: never; }; "/projects/columns/cards/{card_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project card */ post: operations["projects/move-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project column * @description Gets information about a project column. */ get: operations["projects/get-column"]; + put?: never; + post?: never; /** * Delete a project column * @description Deletes a project column. */ delete: operations["projects/delete-column"]; + options?: never; + head?: never; /** Update an existing project column */ patch: operations["projects/update-column"]; + trace?: never; }; "/projects/columns/{column_id}/cards": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project cards * @description Lists the project cards in a project. */ get: operations["projects/list-cards"]; + put?: never; /** Create a project card */ post: operations["projects/create-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project column */ post: operations["projects/move-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/get"]; + put?: never; + post?: never; /** * Delete a project * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ delete: operations["projects/delete"]; + options?: never; + head?: never; /** * Update a project * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ patch: operations["projects/update"]; + trace?: never; }; "/projects/{project_id}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project collaborators * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ get: operations["projects/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add project collaborator * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ put: operations["projects/add-collaborator"]; + post?: never; /** * Remove user as a collaborator * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ delete: operations["projects/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get project permission for a user * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ get: operations["projects/get-permission-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/columns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project columns * @description Lists the project columns in a project. */ get: operations["projects/list-columns"]; + put?: never; /** * Create a project column * @description Creates a new project column. */ post: operations["projects/create-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.9/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.9/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.9/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.9/rest/overview/api-versions)." + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.9/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.9/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.9/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.9/rest/overview/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository * @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. * - * **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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List artifacts for a repository * @description Lists all artifacts for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an artifact * @description Gets a specific artifact for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an artifact * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. - * 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. + * 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. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage-policy": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage policy for a repository * @description Gets GitHub Actions cache usage policy for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-policy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set GitHub Actions cache usage policy for a repository * @description Sets GitHub Actions cache usage policy for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/set-actions-cache-usage-policy"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-list"]; + put?: never; + post?: never; /** * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a job for a workflow run * @description Gets a specific job in a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. + * for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization secrets * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization variables * @description Lists all organization variables shared with a repository. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-variables"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * - * You 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. + * You 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. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-workflow-access-to-repository"]; /** * Set the level of access for workflows outside of the repository * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/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)." + * This endpoint only applies to internal and private repositories. + * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/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)" and + * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-workflow-access-to-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for a repository * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You 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. + * You 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. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions for a repository * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. * - * To 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. + * To 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. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/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)." + * as well as if GitHub Actions can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/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)." + * can submit approving pull request reviews. + * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** * Set custom labels for a self-hosted runner for a repository * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. + * self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository * @description Adds custom labels to a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** * Remove all custom labels from a self-hosted runner for a repository * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. + * repository. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for a repository * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. + * in a repository. Returns the remaining labels from the runner. * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a repository * @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/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run * @description Gets a specific workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Deletes a specific workflow run. * - * Anyone with write access to the repository can use this endpoint. + * Anyone with write access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the review history for a workflow run * @description Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-reviews-for-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow run artifacts * @description Lists artifacts for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run attempt * @description Gets a specific workflow run attempt. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. + * `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @description Deletes all logs for a workflow run. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-pending-deployments-for-run"]; + put?: never; /** * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/review-pending-deployments-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a workflow * @description Re-runs your workflow run using its `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run failed jobs from a workflow run * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow-failed-jobs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository variables * @description Lists all repository variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-variables"]; + put?: never; /** * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-repo-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository variable * @description Gets a specific variable in a repository. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-variable"]; + put?: never; + post?: never; /** * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-variable"]; + options?: never; + head?: never; /** * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-repo-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository workflows * @description Lists the workflows in a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow * @description Gets a specific workflow. You can replace `workflow_id` with the workflow - * file name. For example, you could use `main.yaml`. + * file name. For example, you could use `main.yaml`. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Disable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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`. * - * You 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)." + * You 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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a workflow * @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/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint + * Anyone with read access to the repository can use this endpoint * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.9/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned * @description Checks if a user has permission to be assigned to an issue in this repository. * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. * - * Otherwise a `404` status code is returned. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an autolink reference of a repository * @description This returns a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List branches */ get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a branch */ get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get branch protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -4079,106 +7644,161 @@ export interface paths { * Update branch protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Protecting a branch requires admin or owner permissions to the repository. + * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get admin branch protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pull request review protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit signature protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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/enterprise-server@3.9/articles/signing-commits-with-gpg) in GitHub Help. + * When 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/enterprise-server@3.9/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * **Note**: You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get status checks protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ patch: operations["repos/update-status-check-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all status check contexts * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -4199,1789 +7819,3013 @@ export interface paths { * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists who has access to this protected branch. + * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Disables the ability to restrict who can push to this branch. + * Disables the ability to restrict who can push to this branch. */ delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get apps with access to the protected branch * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * 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/enterprise-server@3.9/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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * 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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get teams with access to the protected branch * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. The list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified teams push access for this branch. You can also give push access to child teams. + * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get users with access to the protected branch * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the people who have push access to this branch. + * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ put: operations["repos/set-user-access-restrictions"]; /** * Add user 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified people push access for this branch. + * Grants the specified people push access for this branch. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ post: operations["repos/add-user-access-restrictions"]; /** * Remove user 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a user to push to this branch. + * Removes the ability of a user to push to this branch. * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/rename": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rename a branch * @description Renames a branch in a repository. * - * **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/enterprise-server@3.9/github/administering-a-repository/renaming-a-branch)". + * **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/enterprise-server@3.9/github/administering-a-repository/renaming-a-branch)". * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ post: operations["repos/rename-branch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check run * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ patch: operations["checks/update"]; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check run annotations * @description Lists annotations for a check run using the annotation `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for a repository * @description Lists all open code scanning alerts for the default branch (usually `main` - * or `master`). 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. + * or `master`). 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. * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch or for the specified Git reference - * (if you used `ref` in the request). + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch or for the specified Git reference + * (if you used `ref` in the request). */ get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning alert * @description Gets a single code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning analyses for a repository * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `category` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set: + * `next_analysis_url` and `confirm_delete_url`. + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in a set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find an analysis that's identified as deletable. + * Each set of analyses always has one that's identified as deletable. + * Having found the deletable analysis for one of the two sets, + * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + * Then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-default-setup"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-default-setup"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif)." * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - 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)." * - * You 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: + * You 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: * - * ``` - * gzip -c analysis-data.sarif | base64 -w0 - * ``` + * ``` + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. | + * | **SARIF data** | **Maximum values** | **Additional limits** | + * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| + * | Runs per file | 20 | | + * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * The `202 Accepted` response includes an `id` value. + * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS - * file. + * file. * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * For more information about the correct CODEOWNERS syntax, + * see "[About code owners](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is a repository collaborator * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/check-collaborator"]; /** * Add a repository collaborator * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * 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-server@3.9/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-server@3.9/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/enterprise-server@3.9/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: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/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: * - * ``` - * Cannot assign {member} permission of {role name} - * ``` + * ``` + * Cannot assign {member} permission of {role name} + * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Updating an existing collaborator's permission level** + * **Updating an existing collaborator's permission level** * - * The 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. + * The 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. */ put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. + * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages + * This endpoint also: + * - Cancels any outstanding invitations + * - Unasigns the user from any issues + * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. + * - Unstars the repository + * - Updates access permissions to packages * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + * Removing a user as a collaborator has the following effects on forks: + * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + * - If the user had their own fork of the repository, the fork will be deleted. + * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. + * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository permissions for a user * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * permissions are `admin`, `write`, `read`, and `none`. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the + * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. */ get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["repos/update-commit-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List branches for HEAD commit * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests associated with a commit * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * - * **Signature verification object** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the combined status for a specific reference * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * * - * Additionally, a combined `state` is returned. The `state` is one of: + * Additionally, a combined `state` is returned. The `state` is one of: * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` */ get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit statuses for a reference * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * - * 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 API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. + * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. * - * **Working with large comparisons** + * **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: + * 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. + * - 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. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." * - * **Signature verification object** + * **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 `verification` object includes the following fields: * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits-with-basehead"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * - * **Notes**: + * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository contributors * @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. * - * 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. + * 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. */ get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for a repository * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a Dependabot alert * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a Dependabot alert * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["dependabot/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @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. + * encrypt a secret before you can create or update secrets. Anyone with read access + * to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ get: operations["dependabot/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["dependabot/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["dependabot/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a diff of the dependencies between commits * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */ get: operations["dependency-graph/diff-range"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/sbom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Export a software bill of materials (SBOM) for a repository. * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. */ get: operations["dependency-graph/export-sbom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a snapshot of dependencies for a repository * @description Create a new snapshot of a repository's dependencies. * - * The authenticated user must have access to the repository. + * The authenticated user must have access to the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["dependency-graph/create-repository-snapshot"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them - * before we merge a pull request. + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them + * before we merge a pull request. * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. + * By default, [commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. * - * Merged branch response: + * Merged branch response: * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. * - * Merge conflict response: + * Merge conflict response: * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. * - * Failed commit status checks: + * Failed commit status checks: * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deployment */ get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * 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. * - * To set a deployment as inactive, you must: + * To set a deployment as inactive, you must: * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. + * * 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/enterprise-server@3.9/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#create-a-deployment-status)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#repository_dispatch)." * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * This input example shows how you can use the `client_payload` as a test to debug your workflow. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment * @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)." * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-environment"]; /** * Create or update an environment * @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)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment secrets * @description Lists all secrets available in an environment without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment public key * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. + * 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. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment secret * @description Gets a single environment secret without revealing its encrypted value. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-secret"]; /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-environment-secret"]; + post?: never; /** * Delete an environment secret * @description Deletes a secret in an environment using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment variables * @description Lists all environment variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-variables"]; + put?: never; /** * Create an environment variable * @description Create an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment variable * @description Gets a specific variable in an environment. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; /** * Delete an environment variable * @description Deletes an environment variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; /** * Update an environment variable * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-environment-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * */ get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List forks */ get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * - **`application/vnd.github.raw+json`**: Returns the raw blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. * - * **Note** This endpoint supports blobs up to 100 megabytes in size. + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit object * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." + * + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List matching references * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a reference * @description Deletes the provided reference. */ delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** * Update a reference * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ patch: operations["git/update-ref"]; + trace?: never; }; "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tag * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference)." * - * Returns an error if you try to delete a file that does not exist. + * Returns an error if you try to delete a file that does not exist. */ post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tree * @description Returns a single tree using the SHA1 value or ref name for that tree. * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. + * share the same `config` as long as those webhooks do not have any `events` that overlap. */ post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ patch: operations["repos/update-invitation"]; + trace?: never; }; "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.9/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments for a repository * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * - * By default, issue comments are ordered by ascending ID. + * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events for a repository * @description Lists events for a repository. */ get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue event * @description Gets a single event by the event id. */ get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-server@3.9/webhooks/event-payloads/#issues) webhook. + * [transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * 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/enterprise-server@3.9/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 - * 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/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. @@ -5992,59 +10836,107 @@ export interface paths { * @description Removes one or more assignees from an issue. */ delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned to a issue * @description 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. + * 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. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * Issue comments are ordered by ascending ID. + * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events * @description Lists all events for an issue. */ get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for an issue * @description Lists all labels for an issue. @@ -6065,183 +10957,403 @@ export interface paths { * @description Removes all labels from an issue. */ delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List deploy keys */ get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deploy key */ get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a repository * @description Lists all labels for a repository. */ get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a label * @description Gets a label using the given name. */ get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ patch: operations["issues/update-label"]; + trace?: never; }; "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable Git LFS for a repository * @description Enables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ put: operations["repos/enable-lfs-for-repo"]; + post?: never; /** * Disable Git LFS for a repository * @description Disables Git LFS for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ delete: operations["repos/disable-lfs-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List milestones * @description Lists milestones for a repository. */ get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ patch: operations["issues/update-milestone"]; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. @@ -6252,352 +11364,585 @@ export interface paths { * @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 Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GitHub Enterprise Server Pages site * @description Gets information about a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub Enterprise Server Pages site * @description Updates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Enterprise Server Pages site * @description Configures a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub Enterprise Server Pages site * @description Deletes a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Enterprise Server Pages builds * @description Lists builts of a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub Enterprise Server Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Enterprise Server Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Enterprise Server Pages build * @description Gets information about a GitHub Enterprise Server Pages build. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * The authenticated user must have write permission to the repository. + * The authenticated user must have write permission to the repository. */ post: operations["repos/create-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pre-receive-hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pre-receive hooks for a repository * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. */ get: operations["enterprise-admin/list-pre-receive-hooks-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive hook for a repository */ get: operations["enterprise-admin/get-pre-receive-hook-for-repo"]; + put?: never; + post?: never; /** * Remove pre-receive hook enforcement for a repository * @description Deletes any overridden enforcement on this repository for the specified hook. * - * Responds with effective values inherited from owner and/or global level. + * Responds with effective values inherited from owner and/or global level. */ delete: operations["enterprise-admin/remove-pre-receive-hook-enforcement-for-repo"]; + options?: never; + head?: never; /** * Update pre-receive hook enforcement for a repository * @description For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` */ patch: operations["enterprise-admin/update-pre-receive-hook-enforcement-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-repo"]; + put?: never; /** * Create a repository project * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests * @description Lists pull requests in a specified repository. * - * 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. + * 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments in a repository * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. + * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists details of a pull request by providing its number. + * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments on a pull request * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. + * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment)." * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reply for a review comment * @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. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits) - * endpoint. + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits) + * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. @@ -6606,16 +11951,29 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. @@ -6626,406 +11984,782 @@ export interface paths { * @description Removes review requests from a pull request for a given set of users and/or teams. */ delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * 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/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/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. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) endpoint. * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List releases * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-tags). * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release asset * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ patch: operations["repos/update-release-asset"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/generate-notes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Generate release notes content for a release * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the latest release * @description View the latest published full release for the repository. * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ patch: operations["repos/update-release"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List release assets */ get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release) to upload a release asset. + * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release) to upload a release asset. * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: * - * `application/zip` + * `application/zip` * - * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. + * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * - * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + * **Notes:** + * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/replicas/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository cache replication status * @description Lists the status of each repository cache replica. */ get: operations["repos/list-cache-info"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["secret-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit activity * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all contributor commit activity * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits */ get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit count * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * - * The array order is oldest week (index 0) to most recent week. + * The array order is oldest week (index 0) to most recent week. * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. + * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the hourly commit count for each day * @description Each array contains the day number, hour number, and number of commits: * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List watchers * @description Lists the people watching the specified repository. */ get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. @@ -7036,75 +12770,175 @@ export interface paths { * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List repository tags */ get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List tag protection states for a repository * @description This returns the tag protection states of a repository. * - * This information is only available to repository administrators. + * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; + put?: never; /** * Create a tag protection state for a repository * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a tag protection state for a repository * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (tar) * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * `main`) 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. */ get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository teams * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. * - * For a public repository, a team is listed only if that team added the public repository explicitly. + * For a public repository, a team is listed only if that team added the public repository explicitly. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all repository topics */ get: operations["repos/get-all-topics"]; /** Replace all repository topics */ put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/). - * You must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account. + * You must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account. */ post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if vulnerability alerts are enabled for a repository * @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/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". @@ -7115,350 +12949,586 @@ export interface paths { * @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/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". */ put: operations["repos/enable-vulnerability-alerts"]; + post?: never; /** * Disable vulnerability alerts * @description Disables dependency alerts 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/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". + * The authenticated user must have admin access to the repository. For more information, + * see "[About security alerts for vulnerable dependencies](https://docs.github.com/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". */ delete: operations["repos/disable-vulnerability-alerts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (zip) * @description 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 - * the `Location` header to make a second `GET` request. + * `main`) 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. + * **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. */ get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public repositories * @description Lists all public repositories in the order that they were created. * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List provisioned SCIM groups for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Lists provisioned SCIM groups in an enterprise. + * Lists provisioned SCIM groups in an enterprise. * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. + * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. */ get: operations["enterprise-admin/list-provisioned-groups-enterprise"]; + put?: never; /** * Provision a SCIM enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Creates a SCIM group for an enterprise. + * Creates a SCIM group for an enterprise. * - * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. + * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. */ post: operations["enterprise-admin/provision-enterprise-group"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Gets information about a SCIM group. + * Gets information about a SCIM group. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-group"]; /** * Set SCIM information for a provisioned enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Replaces an existing provisioned group’s information. + * Replaces an existing provisioned group’s information. * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-group"]; + post?: never; /** * Delete a SCIM group from an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Deletes a SCIM group from an enterprise. + * Deletes a SCIM group from an enterprise. */ delete: operations["enterprise-admin/delete-scim-group-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise group * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Update a provisioned group’s individual attributes. + * Update a provisioned group’s individual attributes. * - * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. + * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. * - * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. + * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. */ patch: operations["enterprise-admin/update-attribute-for-enterprise-group"]; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SCIM provisioned identities for an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Lists provisioned SCIM enterprise members. + * Lists provisioned SCIM enterprise members. * - * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. + * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. */ get: operations["enterprise-admin/list-provisioned-identities-enterprise"]; + put?: never; /** * Provision a SCIM enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Creates an external identity for a new SCIM enterprise user. + * Creates an external identity for a new SCIM enterprise user. * - * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. + * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. * - * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. + * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. */ post: operations["enterprise-admin/provision-enterprise-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get SCIM provisioning information for an enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Gets information about a SCIM user. + * Gets information about a SCIM user. */ get: operations["enterprise-admin/get-provisioning-information-for-enterprise-user"]; /** * Set SCIM information for a provisioned enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Replaces an existing provisioned user's information. + * Replaces an existing provisioned user's information. * - * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. + * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. */ put: operations["enterprise-admin/set-information-for-provisioned-enterprise-user"]; + post?: never; /** * Delete a SCIM user from an enterprise * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. + * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. */ delete: operations["enterprise-admin/delete-user-from-enterprise"]; + options?: never; + head?: never; /** * Update an attribute for a SCIM enterprise user * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. * - * Update a provisioned user's individual attributes. + * Update a provisioned user's individual attributes. * - * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false + * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + * ``` + * { + * "Operations":[{ + * "op":"replace", + * "value":{ + * "active":false + * } + * }] * } - * }] - * } - * ``` + * ``` */ patch: operations["enterprise-admin/update-attribute-for-enterprise-user"]; + trace?: never; }; "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * - * `q=addClass+in:file+language:js+repo:jquery/jquery` + * `q=addClass+in:file+language:js+repo:jquery/jquery` * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. * - * Considerations for code search: + * Considerations for code search: * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. */ get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search commits * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). * - * 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/enterprise-server@3.9/rest/search/search#text-match-metadata). + * 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/enterprise-server@3.9/rest/search/search#text-match-metadata). * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * - * `q=repo:octocat/Spoon-Knife+css` + * `q=repo:octocat/Spoon-Knife+css` */ get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search issues and pull requests * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * - * `q=bug+defect+enhancement&repository_id=64778136` + * `q=bug+defect+enhancement&repository_id=64778136` * - * The labels that best match the query appear first in the search results. + * The labels that best match the query appear first in the search results. */ get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * - * `q=tetris+language:assembly&sort=stars&order=desc` + * `q=tetris+language:assembly&sort=stars&order=desc` * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.9/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * - * `q=ruby+is:featured` + * `q=ruby+is:featured` * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). * - * For example, if you're looking for a list of popular users, you might try this query: + * For example, if you're looking for a list of popular users, you might try this query: * - * `q=tom+repos:%3E42+followers:%3E1000` + * `q=tom+repos:%3E42+followers:%3E1000` * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search)." */ get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/configcheck": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the configuration status * @description This endpoint allows you to check the status of the most recent configuration process: * - * Note that you may need to wait several seconds after you start a process before you can check its status. + * Note that you may need to wait several seconds after you start a process before you can check its status. * - * The different statuses are: + * The different statuses are: * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | + * | Status | Description | + * | ------------- | --------------------------------- | + * | `PENDING` | The job has not started yet | + * | `CONFIGURING` | The job is running | + * | `DONE` | The job has finished correctly | + * | `FAILED` | The job has finished unexpectedly | */ get: operations["enterprise-admin/get-configuration-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/configure": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a configuration process * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: */ post: operations["enterprise-admin/start-configuration-process"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/maintenance": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the maintenance status * @description Check your installation's maintenance status: */ get: operations["enterprise-admin/get-maintenance-status"]; + put?: never; /** * Enable or disable maintenance mode * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ post: operations["enterprise-admin/enable-or-disable-maintenance-mode"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get settings * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings). * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. + * **Note:** You cannot retrieve the management console password with the Enterprise administration API. */ get: operations["enterprise-admin/get-settings"]; /** * Set settings * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). * - * **Notes:** + * **Notes:** * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." */ put: operations["enterprise-admin/set-settings"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/settings/authorized-keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all authorized SSH keys */ get: operations["enterprise-admin/get-all-authorized-ssh-keys"]; + put?: never; /** * Add an authorized SSH key * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). @@ -7469,239 +13539,369 @@ export interface paths { * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). */ delete: operations["enterprise-admin/remove-authorized-ssh-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/start": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub license * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: + * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. + * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. + * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/create-enterprise-server-license"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/setup/api/upgrade": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upgrade a license * @description This API upgrades your license and also triggers the configuration process. * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). */ post: operations["enterprise-admin/upgrade-license"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team) endpoint. * - * To delete a team, the authenticated user must be an organization owner or team maintainer. + * To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team) endpoint. * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. + * List all discussions on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-legacy"]; + put?: never; /** * Create a discussion (Legacy) * @deprecated * @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/enterprise-server@3.9/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. + * Creates a new discussion post on a team's page. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. + * Get a specific discussion on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-legacy"]; + put?: never; + post?: never; /** * Delete a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. + * Delete a discussion from a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-legacy"]; + options?: never; + head?: never; /** * Update a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. + * List all comments on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-legacy"]; + put?: never; /** * Create a discussion comment (Legacy) * @deprecated * @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/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. + * Creates a new comment on a team discussion. * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. + * Get a specific comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-legacy"]; + put?: never; + post?: never; /** * Delete a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. + * Deletes a comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-legacy"]; + options?: never; + head?: never; /** * Update a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. + * Edits the body text of a discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; + put?: never; /** * Create reaction for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-legacy"]; + put?: never; /** * Create reaction for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. */ get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team member (Legacy) * @deprecated * @description The "Get team member" endpoint (described below) is deprecated. * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/get-member-legacy"]; /** @@ -7709,46 +13909,57 @@ export interface paths { * @deprecated * @description The "Add team member" endpoint (described below) is deprecated. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated * @description The "Remove team member" endpoint (described below) is deprecated. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** @@ -7756,47 +13967,71 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * - * If 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. + * If 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. */ put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/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. + * 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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects) endpoint. * - * Lists the organization projects for a team. + * Lists the organization projects for a team. */ get: operations["teams/list-projects-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ get: operations["teams/check-permissions-for-project-legacy"]; /** @@ -7804,35 +14039,59 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ put: operations["teams/add-or-update-project-permissions-legacy"]; + post?: never; /** * Remove a project from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team) endpoint. * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ delete: operations["teams/remove-project-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository (Legacy) * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** @@ -7840,58 +14099,108 @@ export interface paths { * @deprecated * @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/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * - * 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. + * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ patch: operations["users/update-authenticated"]; + trace?: never; }; "/user/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List email addresses for the authenticated user * @description Lists all of your email addresses, and specifies which one is visible - * to the public. + * to the public. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-emails-for-authenticated-user"]; + put?: never; /** * Add an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. @@ -7902,420 +14211,829 @@ export interface paths { * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-email-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a person is followed by the authenticated user */ get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for the authenticated user * @description Lists the current user's GPG keys. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GPG key for the authenticated user * @description View extended details for a single GPG key. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You can find the permissions for the installation under the `permissions` key. + * You can find the permissions for the installation under the `permissions` key. */ get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the user access token * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * The access the user has to each repository is included in the hash under the `permissions` key. + * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user account issues assigned to the authenticated user * @description 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 - * 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/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public SSH keys for the authenticated user * @description Lists the public SSH keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a public SSH key for the authenticated user * @description View extended details for a single public SSH key. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user migrations * @description Lists all migrations a user has started. */ get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a user migration archive * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package for the authenticated user * @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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for the authenticated user * @description Restores a package owned by the authenticated user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package version for the authenticated user * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. + * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package version for the authenticated user * @description Restores a package version owned by the authenticated user. * - * You can restore a deleted package version under the following conditions: - * - 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. + * You can restore a deleted package version under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user project * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/public_emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. + * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-public-emails-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for the authenticated user * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; "/user/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for the authenticated user * @description Lists all of your social accounts. */ get: operations["users/list-social-accounts-for-authenticated-user"]; + put?: never; /** * Add social accounts for the authenticated user * @description Add one or more social accounts to the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user * @description Deletes one or more social accounts from the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-social-account-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for the authenticated user * @description Lists the SSH signing keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; + put?: never; /** * Create a SSH signing key for the authenticated user * @description Creates an SSH signing key for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ post: operations["users/create-ssh-signing-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys/{ssh_signing_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an SSH signing key for the authenticated user * @description Gets extended details for an SSH signing key. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/get-ssh-signing-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete an SSH signing key for the authenticated user * @description Deletes an SSH signing key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. @@ -8326,372 +15044,826 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams for the authenticated user * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. + * user belongs. * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.9/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.9/rest/users/emails)". */ get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. */ get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a user */ get: operations["activity/list-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of a user * @description Lists the people following the specified user. */ get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a user follows another user */ get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for a user * @description Lists public gists for the specified user: */ get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for a user * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; + put?: never; + post?: never; /** * Delete a package for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for a user * @description Restores an entire package for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; + put?: never; + post?: never; /** * Delete package version for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for a user * @description Restores a specific package version for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user projects * @description Lists projects for a user. */ get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events received by the authenticated user * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ get: operations["activity/list-received-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events received by a user */ get: operations["activity/list-received-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/site_admin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Promote a user to be a site administrator * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/promote-user-to-be-site-administrator"]; + post?: never; /** * Demote a site administrator * @description You can demote any user account except your own. */ delete: operations["enterprise-admin/demote-site-administrator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for a user * @description Lists social media accounts for a user. This endpoint is accessible by anyone. */ get: operations["users/list-social-accounts-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for a user * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. */ get: operations["users/list-ssh-signing-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * - * You can suspend any user account except your own. + * You can suspend any user account except your own. * - * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/suspend-user"]; + post?: never; /** * Unsuspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ delete: operations["enterprise-admin/unsuspend-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{base}...{head}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. * - * 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. + * 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. * - * 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. + * 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** + * **Working with large comparisons** * - * 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)." + * 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)." * - * 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. + * 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** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } - export type webhooks = Record; - export interface components { schemas: { root: { @@ -9114,11 +16286,11 @@ export interface components { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ "app-permissions": { /** @@ -9428,12 +16600,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** * Format: uri @@ -9522,9 +16692,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -9537,9 +16707,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -9898,12 +17068,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -10137,7 +17305,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -10170,7 +17338,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -10182,7 +17350,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -10203,69 +17371,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -10274,14 +17442,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -10305,12 +17473,10 @@ export interface components { single_file?: string; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; }; /** @@ -10341,11 +17507,9 @@ export interface components { * @example 2011-09-06T20:39:23Z */ updated_at: string; - /** - * @example [ - * "public_repo" - * ] - */ + /** @example [ + * "public_repo" + * ] */ scopes: string[]; user?: components["schemas"]["nullable-simple-user"]; }; @@ -10363,53 +17527,52 @@ export interface components { * @example https://api.github.com/codes_of_conduct/contributor_covenant */ url: string; - /** - * @example # Contributor Covenant Code of Conduct + /** @example # Contributor Covenant Code of Conduct * - * ## Our Pledge + * ## Our Pledge * - * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. * - * ## Our Standards + * ## Our Standards * - * Examples of behavior that contributes to creating a positive environment include: + * Examples of behavior that contributes to creating a positive environment include: * - * * Using welcoming and inclusive language - * * Being respectful of differing viewpoints and experiences - * * Gracefully accepting constructive criticism - * * Focusing on what is best for the community - * * Showing empathy towards other community members + * * Using welcoming and inclusive language + * * Being respectful of differing viewpoints and experiences + * * Gracefully accepting constructive criticism + * * Focusing on what is best for the community + * * Showing empathy towards other community members * - * Examples of unacceptable behavior by participants include: + * Examples of unacceptable behavior by participants include: * - * * The use of sexualized language or imagery and unwelcome sexual attention or advances - * * Trolling, insulting/derogatory comments, and personal or political attacks - * * Public or private harassment - * * Publishing others' private information, such as a physical or electronic address, without explicit permission - * * Other conduct which could reasonably be considered inappropriate in a professional setting + * * The use of sexualized language or imagery and unwelcome sexual attention or advances + * * Trolling, insulting/derogatory comments, and personal or political attacks + * * Public or private harassment + * * Publishing others' private information, such as a physical or electronic address, without explicit permission + * * Other conduct which could reasonably be considered inappropriate in a professional setting * - * ## Our Responsibilities + * ## Our Responsibilities * - * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - * to any instances of unacceptable behavior. + * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + * to any instances of unacceptable behavior. * - * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. * - * ## Scope + * ## Scope * - * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. * - * ## Enforcement + * ## Enforcement * - * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. * - * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. * - * ## Attribution + * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - */ + * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + * */ body?: string; /** Format: uri */ html_url: string | null; @@ -10591,12 +17754,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -10677,12 +17840,10 @@ export interface components { * @example 2016-07-11T22:14:10Z */ expires_at: string; - /** - * @example { - * "issues": "read", - * "deployments": "write" - * } - */ + /** @example { + * "issues": "read", + * "deployments": "write" + * } */ permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; @@ -10770,32 +17931,32 @@ export interface components { | "dismissed" | "fixed"; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string} @@ -10805,12 +17966,12 @@ export interface components { * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -10849,10 +18010,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ "code-scanning-analysis-analysis-key": string; @@ -10890,10 +18049,8 @@ export interface components { }; location?: components["schemas"]["code-scanning-alert-location"]; html_url?: string; - /** - * @description Classifications that have been applied to the file that triggered the alert. - * For example identifying it as documentation, or a generated file. - */ + /** @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. */ classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; /** @@ -11159,25 +18316,25 @@ export interface components { "enterprise-security-analysis-settings": { /** * @description Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to - * this enterprise. + * this enterprise. * @example false */ advanced_security_enabled_for_new_repositories: boolean; /** * @description Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ dependabot_alerts_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * enterprise. + * enterprise. * @example false */ secret_scanning_enabled_for_new_repositories: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this enterprise. + * transferred to this enterprise. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories: boolean; @@ -11188,15 +18345,15 @@ export interface components { secret_scanning_push_protection_custom_link?: string | null; }; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -11211,7 +18368,7 @@ export interface components { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -11221,7 +18378,7 @@ export interface components { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -11235,14 +18392,14 @@ export interface components { readonly vector_string: string | null; }; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -11252,7 +18409,7 @@ export interface components { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -11279,7 +18436,7 @@ export interface components { * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -11287,10 +18444,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -11328,7 +18485,7 @@ export interface components { * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "nullable-alert-updated-at": string | null; + "nullable-alert-updated-at": string | null; /** * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} @@ -11365,10 +18522,8 @@ export interface components { resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -11534,9 +18689,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -11549,9 +18704,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -11650,14 +18805,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -11667,9 +18821,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -11806,11 +18959,9 @@ export interface components { current_user_actor_url?: string; /** @example https://github.com/octocat-org */ current_user_organization_url?: string; - /** - * @example [ - * "https://github.com/organizations/github/octocat.private.atom?token=abc123" - * ] - */ + /** @example [ + * "https://github.com/organizations/github/octocat.private.atom?token=abc123" + * ] */ current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ security_advisories_url?: string; @@ -11857,13 +19008,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12004,13 +19157,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12036,15 +19191,17 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; + [key: string]: + | ({ + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + } | null) + | undefined; }; public?: boolean; created_at?: string; @@ -12119,25 +19276,24 @@ export interface components { "gitignore-template": { /** @example C */ name: string; - /** - * @example # Object files - * *.o + /** @example # Object files + * *.o * - * # Libraries - * *.lib - * *.a + * # Libraries + * *.lib + * *.a * - * # Shared objects (inc. Windows DLLs) - * *.dll - * *.so - * *.so.* - * *.dylib + * # Shared objects (inc. Windows DLLs) + * *.dll + * *.so + * *.so.* + * *.dylib * - * # Executables - * *.exe - * *.out - * *.app - */ + * # Executables + * *.exe + * *.out + * *.app + * */ source: string; }; /** @@ -12188,53 +19344,46 @@ export interface components { description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ implementation: string; - /** - * @example [ - * "commercial-use", - * "modifications", - * "distribution", - * "sublicense", - * "private-use" - * ] - */ + /** @example [ + * "commercial-use", + * "modifications", + * "distribution", + * "sublicense", + * "private-use" + * ] */ permissions: string[]; - /** - * @example [ - * "include-copyright" - * ] - */ + /** @example [ + * "include-copyright" + * ] */ conditions: string[]; - /** - * @example [ - * "no-liability" - * ] - */ + /** @example [ + * "no-liability" + * ] */ limitations: string[]; - /** - * @example + /** @example * - * The MIT License (MIT) + * The MIT License (MIT) * - * Copyright (c) [year] [fullname] + * Copyright (c) [year] [fullname] * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * */ body: string; /** @example true */ featured: boolean; @@ -12304,17 +19453,13 @@ export interface components { "api-overview": { /** @example true */ verifiable_password_authentication: boolean; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ dependabot?: string[]; domains?: { website?: string[]; @@ -12751,47 +19896,47 @@ export interface components { /** * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; @@ -12874,12 +20019,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -13345,15 +20490,15 @@ export interface components { /** * @description An array of teams linked to this group * @example [ - * { - * "team_id": 1, - * "team_name": "team-test" - * }, - * { - * "team_id": 2, - * "team_name": "team-test2" - * } - * ] + * { + * "team_id": 1, + * "team_name": "team-test" + * }, + * { + * "team_id": 2, + * "team_name": "team-test2" + * } + * ] */ teams: { /** @@ -13370,19 +20515,19 @@ export interface components { /** * @description An array of external members linked to this group * @example [ - * { - * "member_id": 1, - * "member_login": "mona-lisa_eocsaxrs", - * "member_name": "Mona Lisa", - * "member_email": "mona_lisa@github.com" - * }, - * { - * "member_id": 2, - * "member_login": "octo-lisa_eocsaxrs", - * "member_name": "Octo Lisa", - * "member_email": "octo_lisa@github.com" - * } - * ] + * { + * "member_id": 1, + * "member_login": "mona-lisa_eocsaxrs", + * "member_name": "Mona Lisa", + * "member_email": "mona_lisa@github.com" + * }, + * { + * "member_id": 2, + * "member_login": "octo-lisa_eocsaxrs", + * "member_name": "Octo Lisa", + * "member_email": "octo_lisa@github.com" + * } + * ] */ members: { /** @@ -13415,17 +20560,17 @@ export interface components { /** * @description An array of external groups available to be mapped to a team * @example [ - * { - * "group_id": 1, - * "group_name": "group-azuread-test", - * "updated_at": "2021-01-03 22:27:15:000 -700" - * }, - * { - * "group_id": 2, - * "group_name": "group-azuread-test2", - * "updated_at": "2021-06-03 22:27:15:000 -700" - * } - * ] + * { + * "group_id": 1, + * "group_name": "group-azuread-test", + * "updated_at": "2021-01-03 22:27:15:000 -700" + * }, + * { + * "group_id": 2, + * "group_name": "group-azuread-test2", + * "updated_at": "2021-06-03 22:27:15:000 -700" + * } + * ] */ groups?: { /** @@ -13469,12 +20614,10 @@ export interface components { deliveries_url?: string; /** @example web */ name: string; - /** - * @example [ - * "push", - * "pull_request" - * ] - */ + /** @example [ + * "push", + * "pull_request" + * ] */ events: string[]; /** @example true */ active: boolean; @@ -13913,7 +21056,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -13946,7 +21089,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -13958,7 +21101,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -13979,69 +21122,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -14050,14 +21193,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -14264,14 +21407,12 @@ export interface components { open_issues_count: number; /** @example true */ is_template?: boolean; - /** - * @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] - */ + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ topics?: string[]; /** @example true */ has_issues: boolean; @@ -14333,8 +21474,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @example PR_TITLE * @enum {string} */ @@ -14342,9 +21483,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -14352,8 +21493,8 @@ export interface components { /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @example PR_TITLE * @enum {string} */ @@ -14361,9 +21502,9 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -14388,7 +21529,7 @@ export interface components { * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; + anonymous_access_enabled: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; }; @@ -15159,7 +22300,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -15197,7 +22338,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -15218,44 +22359,44 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - allow_forking?: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -15600,10 +22741,10 @@ export interface components { /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ - * "self-hosted", - * "foo", - * "bar" - * ] + * "self-hosted", + * "foo", + * "bar" + * ] */ labels: string[]; /** @@ -15697,9 +22838,9 @@ export interface components { "actions-workflow-access-to-repository": { /** * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the - * repository. + * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise. * @enum {string} */ access_level: "none" | "user" | "organization" | "enterprise"; @@ -16054,14 +23195,11 @@ export interface components { * @example deploy */ task: string; - payload: OneOf< - [ - { + payload: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** @example staging */ original_environment?: string; /** @@ -16244,7 +23382,7 @@ export interface components { * @default false * @example true */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; }; /** * Branch Restriction Policy @@ -16390,12 +23528,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -16583,11 +23721,9 @@ export interface components { url: string; /** @example true */ strict: boolean; - /** - * @example [ - * "continuous-integration/travis-ci" - * ] - */ + /** @example [ + * "continuous-integration/travis-ci" + * ] */ contexts: string[]; checks: { /** @example continuous-integration/travis-ci */ @@ -16618,7 +23754,7 @@ export interface components { * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; dismissal_restrictions?: { /** Format: uri */ url: string; @@ -16669,12 +23805,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -17052,12 +24188,12 @@ export interface components { * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; + "code-scanning-analysis-url": string; "code-scanning-analysis": { ref: components["schemas"]["code-scanning-ref"]; commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; @@ -17092,12 +24228,12 @@ export interface components { * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + readonly next_analysis_url: string | null; /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; + readonly confirm_delete_url: string | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { @@ -17145,10 +24281,8 @@ export interface components { query_suite?: "default" | "extended"; [key: string]: unknown; }; - /** - * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. - * You should not rely on this always being an actions workflow run object. - */ + /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. + * You should not rely on this always being an actions workflow run object. */ "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ run_id?: number; @@ -17157,7 +24291,7 @@ export interface components { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -17169,7 +24303,7 @@ export interface components { * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; + readonly url?: string; }; "code-scanning-sarifs-status": { /** @@ -17181,9 +24315,9 @@ export interface components { * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** * CODEOWNERS errors @@ -17220,8 +24354,8 @@ export interface components { * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: * - * * user - * ^ + * * user + * ^ */ message: string; /** @@ -17956,10 +25090,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -18099,19 +25233,19 @@ export interface components { name?: string; /** * @description The version of the package. If the package does not have an exact version specified, - * a version range is given. + * a version range is given. * @example 1.0.0 */ versionInfo?: string; /** * @description The location where the package can be downloaded, - * or NOASSERTION if this has not been determined. + * or NOASSERTION if this has not been determined. * @example NOASSERTION */ downloadLocation?: string; /** * @description Whether the package's file content has been subjected to - * analysis during the creation of the SPDX document. + * analysis during the creation of the SPDX document. * @example false */ filesAnalyzed?: boolean; @@ -18122,7 +25256,7 @@ export interface components { licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information - * was not available when the SPDX document was created. + * was not available when the SPDX document was created. * @example NOASSERTION */ licenseDeclared?: string; @@ -18156,7 +25290,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: (string | number | boolean) | null; + [key: string]: ((string | number | boolean) | null) | undefined; }; dependency: { /** @@ -18199,7 +25333,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"]; + [key: string]: components["schemas"]["dependency"] | undefined; }; }; /** @@ -18257,7 +25391,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"]; + [key: string]: components["schemas"]["manifest"] | undefined; }; /** * Format: date-time @@ -18305,7 +25439,7 @@ export interface components { * @default * @example production */ - environment?: string; + environment: string; /** * Format: uri * @description Deprecated: the URL to associate with this status. @@ -18339,14 +25473,14 @@ export interface components { * @default * @example https://staging.example.com/ */ - environment_url?: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - log_url?: string; + log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** @@ -18454,8 +25588,8 @@ export interface components { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -18465,8 +25599,8 @@ export interface components { /** * @description The name pattern that branches must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -18648,43 +25782,43 @@ export interface components { /** * @description Objects specifying a tree structure * @example [ - * { - * "path": "file.rb", - * "mode": "100644", - * "type": "blob", - * "size": 30, - * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" + * { + * "path": "file.rb", + * "mode": "100644", + * "type": "blob", + * "size": 30, + * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", + * "properties": { + * "path": { + * "type": "string" + * }, + * "mode": { + * "type": "string" + * }, + * "type": { + * "type": "string" + * }, + * "size": { + * "type": "integer" + * }, + * "sha": { + * "type": "string" + * }, + * "url": { + * "type": "string" + * } + * }, + * "required": [ + * "path", + * "mode", + * "type", + * "sha", + * "url", + * "size" + * ] * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" * ] - * } - * ] */ tree: { /** @example test/file.rb */ @@ -18731,9 +25865,9 @@ export interface components { /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ - * "push", - * "pull_request" - * ] + * "push", + * "pull_request" + * ] */ events: string[]; config: components["schemas"]["webhook-config"]; @@ -18857,14 +25991,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -18874,9 +26007,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -19678,7 +26810,7 @@ export interface components { * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -19694,7 +26826,7 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} @@ -19820,7 +26952,7 @@ export interface components { * @description Language */ language: { - [key: string]: number; + [key: string]: number | undefined; }; /** * License Content @@ -19960,9 +27092,9 @@ export interface components { /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ - * "example.com", - * "www.example.com" - * ] + * "example.com", + * "www.example.com" + * ] */ domains: string[]; /** Format: date */ @@ -20743,13 +27875,13 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -20889,10 +28021,8 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -21088,17 +28218,15 @@ export interface components { * @description Commit Activity */ "commit-activity": { - /** - * @example [ - * 0, - * 3, - * 26, - * 20, - * 39, - * 1, - * 0 - * ] - */ + /** @example [ + * 0, + * 3, + * 26, + * 20, + * 39, + * 1, + * 0 + * ] */ days: number[]; /** @example 89 */ total: number; @@ -21113,16 +28241,14 @@ export interface components { author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ total: number; - /** - * @example [ - * { - * "w": "1367712000", - * "a": 6898, - * "d": 77, - * "c": 10 - * } - * ] - */ + /** @example [ + * { + * "w": "1367712000", + * "a": 6898, + * "d": 77, + * "c": 10 + * } + * ] */ weeks: { w?: number; a?: number; @@ -21215,8 +28341,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: ( | "urn:ietf:params:scim:schemas:core:2.0:Group" @@ -21277,17 +28403,17 @@ export interface components { /** * @description The security group members. * @example [ - * { - * "value": "879db59-3bdf-4490-ad68-ab880a2694745", - * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", - * "displayName": "User 1" - * }, - * { - * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", - * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", - * "displayName": "User 2" - * } - * ] + * { + * "value": "879db59-3bdf-4490-ad68-ab880a2694745", + * "$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745", + * "displayName": "User 1" + * }, + * { + * "value": "0db508eb-91e2-46e4-809c-30dcbda0c685", + * "$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685", + * "displayName": "User 2" + * } + * ] */ members?: { value?: string; @@ -21300,8 +28426,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -21326,8 +28452,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:Group" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:Group" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:Group"[]; /** @@ -21435,8 +28561,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -21481,8 +28607,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the list SCIM schemas. * @example [ - * "urn:ietf:params:scim:api:messages:2.0:ListResponse" - * ] + * "urn:ietf:params:scim:api:messages:2.0:ListResponse" + * ] */ schemas: "urn:ietf:params:scim:api:messages:2.0:ListResponse"[]; /** @@ -21547,8 +28673,8 @@ export interface components { /** * @description The URIs that are used to indicate the namespaces of the SCIM schemas. * @example [ - * "urn:ietf:params:scim:schemas:core:2.0:User" - * ] + * "urn:ietf:params:scim:schemas:core:2.0:User" + * ] */ schemas: "urn:ietf:params:scim:schemas:core:2.0:User"[]; /** @@ -21606,12 +28732,10 @@ export interface components { language?: string | null; /** Format: date-time */ last_modified_at?: string; - /** - * @example [ - * "73..77", - * "77..78" - * ] - */ + /** @example [ + * "73..77", + * "77..78" + * ] */ line_numbers?: string[]; text_matches?: components["schemas"]["search-result-text-matches"]; }; @@ -22276,36 +29400,32 @@ export interface components { key_id: string; /** @example xsBNBFayYZ... */ public_key: string; - /** - * @example [ - * { - * "email": "octocat@users.noreply.github.com", - * "verified": true - * } - * ] - */ + /** @example [ + * { + * "email": "octocat@users.noreply.github.com", + * "verified": true + * } + * ] */ emails: { email?: string; verified?: boolean; }[]; - /** - * @example [ - * { - * "id": 4, - * "primary_key_id": 3, - * "key_id": "4A595D4C72EE49C7", - * "public_key": "zsBNBFayYZ...", - * "emails": [], - * "can_sign": false, - * "can_encrypt_comms": true, - * "can_encrypt_storage": true, - * "can_certify": false, - * "created_at": "2016-03-24T11:31:04-06:00", - * "expires_at": null, - * "revoked": false - * } - * ] - */ + /** @example [ + * { + * "id": 4, + * "primary_key_id": 3, + * "key_id": "4A595D4C72EE49C7", + * "public_key": "zsBNBFayYZ...", + * "emails": [], + * "can_sign": false, + * "can_encrypt_comms": true, + * "can_encrypt_storage": true, + * "can_certify": false, + * "created_at": "2016-03-24T11:31:04-06:00", + * "expires_at": null, + * "revoked": false + * } + * ] */ subkeys: { id?: number; primary_key_id?: number; @@ -22407,8 +29527,9 @@ export interface components { /** * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured - * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.9/admin/overview/about-enterprise-accounts)." + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.9/admin/overview/about-enterprise-accounts)." + * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -22456,8 +29577,8 @@ export interface components { /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured - * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * for and sent to a GitHub App. For more information, + * see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -22474,7 +29595,7 @@ export interface components { /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an - * organization, or when the event occurs from activity in a repository owned by an organization. + * organization, or when the event occurs from activity in a repository owned by an organization. */ "organization-simple-webhooks": { /** @example github */ @@ -22514,7 +29635,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "repository-webhooks": { /** @@ -22716,7 +29837,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -22748,7 +29869,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -22760,7 +29881,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -22781,7 +29902,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -22891,34 +30012,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -22932,62 +30053,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -22996,14 +30117,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -23581,8 +30702,8 @@ export interface components { repository_url: string; /** * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. * @enum {string} */ state: "open" | "closed" | "locked" | "converting" | "transferring"; @@ -24960,7 +32081,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** @@ -25162,7 +32283,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -25194,7 +32315,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -25206,7 +32327,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -25227,7 +32348,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -25337,34 +32458,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -25378,62 +32499,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -25442,14 +32563,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -25807,41 +32928,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -25849,7 +32970,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; /** Pull Request */ webhooks_pull_request_5: { @@ -26054,24 +33175,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -26107,7 +33228,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -26191,17 +33312,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -26268,7 +33389,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -26276,17 +33397,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -26318,7 +33439,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -26394,24 +33515,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -26447,7 +33568,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -26531,17 +33652,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -26608,7 +33729,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -26616,17 +33737,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -26658,7 +33779,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -26848,9 +33969,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -26885,8 +34005,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -26936,9 +34056,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -29484,7 +36603,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: Record | null; + dismissed_by: Record; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -30496,7 +37615,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -30815,7 +37934,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -31173,7 +38292,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -31503,7 +38622,7 @@ export interface components { id: number; node_id: string; original_environment: string; - payload: string | Record | null; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -32511,24 +39630,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -32568,7 +39687,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -32707,7 +39826,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -32790,7 +39909,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: Record | null; + license?: Record; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -33649,7 +40768,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -33676,10 +40795,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -34238,7 +41357,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34265,10 +41384,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -34830,7 +41949,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34857,10 +41976,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -35402,8 +42521,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -35413,13 +42532,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -38846,24 +45965,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -38899,7 +46018,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -39040,7 +46159,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -40530,24 +47649,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -40583,7 +47702,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -40727,7 +47846,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -41342,12 +48461,10 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { - /** - * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - * assigned to the collaborator, use the `role_name` field instead, which will provide the full - * role name, including custom roles. - */ + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; @@ -41781,11 +48898,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string; + [key: string]: string | undefined; }; repo?: string; dependencies?: { - [key: string]: string; + [key: string]: string | undefined; }[]; commit_oid?: string; }; @@ -41885,8 +49002,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -41911,19 +49028,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: Record | null; - bugs?: Record | null; + author?: Record; + bugs?: Record; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: Record | null; + dist?: Record; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: Record | null; + repository?: Record; scripts?: Record; id?: string; node_version?: string; @@ -41936,7 +49053,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: Record | null; + directories?: Record; os?: string[]; cpu?: string[]; readme?: string; @@ -41950,19 +49067,16 @@ export interface components { | { id?: number | string; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -42803,22 +49917,19 @@ export interface components { "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; - changes?: OneOf< - [ - { + changes?: + | { field_value: { field_node_id?: string; field_type?: string; }; - }, - { + } + | { body: { from?: string | null; to?: string | null; }; - }, - ] - >; + }; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; @@ -43078,24 +50189,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -43131,7 +50242,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -43215,17 +50326,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -43292,7 +50403,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -43300,9 +50411,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -43312,8 +50423,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -43345,7 +50456,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -43421,24 +50532,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -43474,7 +50585,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -43558,17 +50669,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -43635,7 +50746,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -43643,9 +50754,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -43655,8 +50766,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -43688,7 +50799,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -43878,9 +50989,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -43915,8 +51025,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -43966,9 +51076,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -44290,24 +51399,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -44343,7 +51452,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -44427,17 +51536,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -44504,7 +51613,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -44512,9 +51621,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -44524,8 +51633,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -44557,7 +51666,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -44633,24 +51742,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -44686,7 +51795,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -44770,17 +51879,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -44847,7 +51956,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -44855,9 +51964,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -44867,8 +51976,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -44900,7 +52009,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45090,9 +52199,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45127,8 +52235,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -45178,9 +52286,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -45503,24 +52610,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -45556,7 +52663,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -45640,17 +52747,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -45717,7 +52824,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -45725,9 +52832,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -45737,8 +52844,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -45770,7 +52877,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45846,24 +52953,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -45899,7 +53006,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -45983,17 +53090,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46060,7 +53167,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46068,9 +53175,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46080,8 +53187,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46113,7 +53220,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46303,9 +53410,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -46340,8 +53446,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -46391,9 +53497,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -46784,24 +53889,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46837,7 +53942,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46921,17 +54026,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46998,7 +54103,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47006,9 +54111,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47018,8 +54123,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47051,7 +54156,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -47127,24 +54232,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47180,7 +54285,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47264,17 +54369,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47341,7 +54446,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47349,9 +54454,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47361,8 +54466,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47394,7 +54499,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -47584,9 +54689,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47621,8 +54725,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -47672,9 +54776,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -47996,24 +55099,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48049,7 +55152,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48133,17 +55236,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48210,7 +55313,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48218,9 +55321,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48230,8 +55333,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48263,7 +55366,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48339,24 +55442,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48392,7 +55495,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48476,17 +55579,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48553,7 +55656,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48561,9 +55664,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48573,8 +55676,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48606,7 +55709,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48796,9 +55899,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48833,8 +55935,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -48884,9 +55986,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -49406,24 +56507,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -49459,7 +56560,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49543,17 +56644,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49620,7 +56721,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49628,9 +56729,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -49640,8 +56741,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49673,7 +56774,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -49742,24 +56843,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -49795,7 +56896,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49844,7 +56945,7 @@ export interface components { * @description Whether discussions are enabled. * @default false */ - has_discussions?: boolean; + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -49879,17 +56980,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49956,7 +57057,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49964,9 +57065,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -49976,8 +57077,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50009,7 +57110,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50154,9 +57255,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50191,8 +57291,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -50242,9 +57342,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -50558,24 +57657,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50611,7 +57710,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50695,17 +57794,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50772,7 +57871,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50780,9 +57879,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50792,8 +57891,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50825,7 +57924,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50894,24 +57993,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50947,7 +58046,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51031,17 +58130,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51108,7 +58207,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51116,9 +58215,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51128,8 +58227,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51161,7 +58260,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51306,9 +58405,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51343,8 +58441,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -51394,9 +58492,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -51711,24 +58808,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51764,7 +58861,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51848,17 +58945,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51925,7 +59022,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51933,9 +59030,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51945,8 +59042,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51978,7 +59075,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52047,24 +59144,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52100,7 +59197,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52184,17 +59281,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52261,7 +59358,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52269,9 +59366,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52281,8 +59378,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52314,7 +59411,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52459,9 +59556,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52496,8 +59592,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -52547,9 +59643,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -52863,24 +59958,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52916,7 +60011,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53000,17 +60095,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53077,7 +60172,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53085,9 +60180,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53097,8 +60192,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53130,7 +60225,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53199,24 +60294,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53252,7 +60347,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53336,17 +60431,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53413,7 +60508,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53421,9 +60516,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53433,8 +60528,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53466,7 +60561,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53611,9 +60706,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53648,8 +60742,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -53699,9 +60793,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -54102,24 +61195,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54155,7 +61248,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54294,7 +61387,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54389,24 +61482,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54442,7 +61535,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54581,7 +61674,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54752,9 +61845,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54789,8 +61881,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -54840,9 +61932,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -54949,9 +62040,8 @@ export interface components { sender: components["schemas"]["simple-user-webhooks"]; }; /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": OneOf< - [ - { + "webhook-pull-request-review-request-removed": + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -55162,24 +62252,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55215,7 +62305,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55299,17 +62389,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -55376,7 +62466,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55422,7 +62512,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -55498,24 +62588,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55551,7 +62641,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55635,17 +62725,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -55712,7 +62802,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55720,9 +62810,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -55732,8 +62822,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -55765,7 +62855,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -55955,9 +63045,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55992,8 +63081,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -56043,9 +63132,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -56192,8 +63280,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -56404,24 +63492,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56457,7 +63545,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56541,17 +63629,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56618,7 +63706,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56626,9 +63714,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -56638,8 +63726,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -56671,7 +63759,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56747,24 +63835,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56800,7 +63888,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56884,17 +63972,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56961,7 +64049,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56969,9 +64057,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -56981,8 +64069,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57014,7 +64102,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57204,9 +64292,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57241,8 +64328,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -57292,9 +64379,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -57459,13 +64545,10 @@ export interface components { url: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request review_requested event */ - "webhook-pull-request-review-requested": OneOf< - [ - { + "webhook-pull-request-review-requested": + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -57676,24 +64759,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57729,7 +64812,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57813,17 +64896,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57890,7 +64973,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57898,9 +64981,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57910,8 +64993,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57943,7 +65026,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58019,24 +65102,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58072,7 +65155,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58156,17 +65239,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58233,7 +65316,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58241,9 +65324,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58253,8 +65336,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58286,7 +65369,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58476,9 +65559,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -58513,8 +65595,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -58564,9 +65646,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -58713,8 +65794,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -58925,24 +66006,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58978,7 +66059,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59062,17 +66143,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59139,7 +66220,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59147,9 +66228,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59159,8 +66240,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -59192,7 +66273,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59268,24 +66349,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59321,7 +66402,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59405,17 +66486,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59482,7 +66563,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59490,9 +66571,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59502,8 +66583,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -59535,7 +66616,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59725,9 +66806,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -59762,8 +66842,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -59813,9 +66893,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -59980,9 +67059,7 @@ export interface components { url?: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { /** @enum {string} */ @@ -60192,24 +67269,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60245,7 +67322,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60329,17 +67406,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60406,7 +67483,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60414,9 +67491,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60426,8 +67503,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60459,7 +67536,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60528,24 +67605,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60581,7 +67658,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60665,17 +67742,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60742,7 +67819,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60750,9 +67827,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60762,8 +67839,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60795,7 +67872,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60940,9 +68017,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -60977,8 +68053,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -61028,9 +68104,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -61345,24 +68420,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61398,7 +68473,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61542,7 +68617,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61639,24 +68714,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61692,7 +68767,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61836,7 +68911,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62009,9 +69084,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -62046,8 +69120,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -62097,9 +69171,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -62565,24 +69638,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62618,7 +69691,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62762,7 +69835,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62859,24 +69932,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62912,7 +69985,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63056,7 +70129,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63229,9 +70302,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -63266,8 +70338,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -63317,9 +70389,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -63789,24 +70860,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63842,7 +70913,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63926,17 +70997,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -64003,7 +71074,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64011,9 +71082,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64023,8 +71094,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64056,7 +71127,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -64132,24 +71203,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64185,7 +71256,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64339,7 +71410,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64347,9 +71418,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64359,8 +71430,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64392,7 +71463,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -64582,9 +71653,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -64619,8 +71689,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -64670,9 +71740,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -64995,24 +72064,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65048,7 +72117,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65132,17 +72201,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65209,7 +72278,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65217,9 +72286,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65229,8 +72298,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65262,7 +72331,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65338,24 +72407,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65391,7 +72460,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65475,17 +72544,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65552,7 +72621,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65560,9 +72629,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65572,8 +72641,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65605,7 +72674,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65795,9 +72864,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -65832,8 +72900,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -65883,9 +72951,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -66208,24 +73275,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66261,7 +73328,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66345,17 +73412,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66422,7 +73489,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66430,9 +73497,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66442,8 +73509,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66475,7 +73542,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66551,24 +73618,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66604,7 +73671,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66758,7 +73825,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66766,9 +73833,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66778,8 +73845,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66811,7 +73878,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67001,9 +74068,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -67038,8 +74104,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -67089,9 +74155,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -67413,24 +74478,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67466,7 +74531,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67550,17 +74615,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -67627,7 +74692,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67635,9 +74700,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67647,8 +74712,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -67680,7 +74745,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67756,24 +74821,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67809,7 +74874,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67893,17 +74958,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -67970,7 +75035,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67978,9 +75043,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67990,8 +75055,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -68023,7 +75088,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68213,9 +75278,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -68250,8 +75314,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -68301,9 +75365,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -68558,24 +75621,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68611,7 +75674,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68755,7 +75818,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68852,8 +75915,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -68877,19 +75940,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: string | Record | null; - bugs?: string | Record | null; + author?: (string | Record) | null; + bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: string | Record | null; + dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: string | Record | null; + repository?: (string | Record) | null; scripts?: Record; id?: string; node_version?: string; @@ -68902,7 +75965,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: string | Record | null; + directories?: (string | Record) | null; os?: string[]; cpu?: string[]; readme?: string; @@ -68914,21 +75977,18 @@ export interface components { } | null; nuget_metadata?: | { - id?: string | Record | number | null; + id?: (string | Record | number) | null; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -69125,7 +76185,7 @@ export interface components { updated_at: string; version: string; }; - registry: Record | null; + registry: Record; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -70204,24 +77264,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70257,7 +77317,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70396,7 +77456,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -70449,24 +77509,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70502,7 +77562,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70641,7 +77701,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -70694,24 +77754,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70747,7 +77807,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70886,7 +77946,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -70970,24 +78030,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71023,7 +78083,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71162,7 +78222,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71215,24 +78275,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71268,7 +78328,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71407,7 +78467,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71587,7 +78647,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: (Record | null)[]; + steps?: Record[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -73208,18 +80268,27 @@ export interface components { responses: { /** @description Resource not found */ not_found: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Bad Request */ bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -73227,40 +80296,61 @@ export interface components { }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ accepted: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description Not modified */ not_modified: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Requires authentication */ requires_authentication: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Gone */ gone: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response */ actions_runner_labels: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -73270,6 +80360,9 @@ export interface components { }; /** @description Response */ actions_runner_labels_readonly: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -73279,6 +80372,9 @@ export interface components { }; /** @description Service unavailable */ service_unavailable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -73289,12 +80385,18 @@ export interface components { }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden Gist */ forbidden_gist: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { block?: { @@ -73309,66 +80411,102 @@ export interface components { }; /** @description Moved permanently */ moved_permanently: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Conflict */ conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Temporary Redirect */ temporary_redirect: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Internal Error */ internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if there is already a validation run in progress with a different default setup configuration */ code_scanning_conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Found */ found: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ dependency_review_forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unacceptable */ unacceptable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description A header with no content is returned. */ no_content: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Bad request */ scim_bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -73376,14 +80514,23 @@ export interface components { }; /** @description Authorization failure */ authorization_failure: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Permission denied */ permission_denied: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Too many requests */ scim_too_many_requests: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -73391,6 +80538,9 @@ export interface components { }; /** @description Internal server error */ scim_internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["scim-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -73398,18 +80548,21 @@ export interface components { }; /** @description Duplicate record detected */ duplicate_record_detected: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; parameters: { /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "per-page"?: number; + "per-page": number; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: number; + page: number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction?: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The unique identifier of the team. */ @@ -73425,10 +80578,10 @@ export interface components { /** @description The unique identifier of the token. */ "token-id": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: string; + cursor: string; "delivery-id": number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: string; + since: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The unique identifier of the grant. */ @@ -73445,7 +80598,7 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization"?: string; + "visible-to-organization": string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ @@ -73453,136 +80606,116 @@ export interface components { /** @description The name of a self-hosted runner's custom label. */ "runner-label-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ - "audit-log-enterprise-phrase"?: string; - /** - * @description The event types to include: + "audit-log-enterprise-phrase": string; + /** @description The event types to include: * - * - `web` - returns web (non-Git) events. - * - `git` - returns Git events. - * - `all` - returns both web and Git events. + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. * - * The default is `web`. - */ - "audit-log-include"?: "web" | "git" | "all"; + * The default is `web`. */ + "audit-log-include": "web" | "git" | "all"; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after"?: string; + "audit-log-after": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before"?: string; - /** - * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + "audit-log-before": string; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * - * The default is `desc`. - */ - "audit-log-order"?: "desc" | "asc"; + * The default is `desc`. */ + "audit-log-order": "desc" | "asc"; /** @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. */ - "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @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. */ - "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; + "pagination-before": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + "pagination-after": string; + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - "dependabot-alert-comma-separated-states"?: string; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ + "dependabot-alert-comma-separated-states": string; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * - * Can be: `low`, `medium`, `high`, `critical` - */ - "dependabot-alert-comma-separated-severities"?: string; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * Can be: `low`, `medium`, `high`, `critical` */ + "dependabot-alert-comma-separated-severities": string; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - "dependabot-alert-comma-separated-ecosystems"?: string; + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ + "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages"?: string; + "dependabot-alert-comma-separated-packages": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope"?: "development" | "runtime"; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - */ - "dependabot-alert-sort"?: "created" | "updated"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first"?: number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last"?: number; + "dependabot-alert-scope": "development" | "runtime"; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ + "dependabot-alert-sort": "created" | "updated"; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ + "pagination-first": number; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ + "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ - "secret-scanning-alert-secret-type"?: string; + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution"?: string; + "secret-scanning-alert-resolution": string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort"?: "created" | "updated"; + "secret-scanning-alert-sort": "created" | "updated"; /** @description The security feature to enable or disable. */ "enterprise-security-product": | "advanced_security" | "dependabot_alerts" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the enterprise. - * `disable_all` means to disable the specified security feature for all repositories in the enterprise. - */ + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ "enterprise-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: string; + labels: string; /** @description The UUID which identifies a node. */ - uuid?: string; + uuid: string; /** @description The cluster roles from the cluster configuration file. */ - "cluster-roles"?: string; + "cluster-roles": string; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all?: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: string; + before: string; /** @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/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org"?: number; + "since-org": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - "visible-to-repository"?: string; + "visible-to-repository": string; /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "variables-per-page"?: number; + "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase"?: string; + "audit-log-phrase": string; /** @description The unique identifier of the role. */ "role-id": number; /** @description The unique identifier of the group. */ @@ -73591,13 +80724,11 @@ export interface components { "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - */ - "package-visibility"?: "public" | "private" | "internal"; + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ + "package-visibility": "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ "package-type": | "npm" @@ -73611,9 +80742,9 @@ export interface components { /** @description Unique identifier of the package version. */ "package-version-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo"?: string; + "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo"?: string; + "secret-scanning-pagination-after-org-repo": string; /** @description The slug of the team name. */ "team-slug": string; /** @description The number that identifies the discussion. */ @@ -73633,27 +80764,25 @@ export interface components { | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the card. */ "card-id": number; /** @description The unique identifier of the column. */ "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - "artifact-name"?: string; + "artifact-name": string; /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full"?: string; + "actions-cache-git-ref-full": string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key"?: string; + "actions-cache-key": string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort"?: + "actions-cache-list-sort": | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -73664,13 +80793,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch"?: string; + "workflow-run-branch": string; /** @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/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: string; + event: string; /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ - "workflow-run-status"?: + "workflow-run-status": | "completed" | "action_required" | "cancelled" @@ -73686,13 +80815,13 @@ export interface components { | "waiting" | "pending"; /** @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/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests"?: boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id"?: number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha"?: string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -73708,11 +80837,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name"?: string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - status?: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @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`. */ - "git-ref"?: components["schemas"]["code-scanning-ref"]; + "git-ref": components["schemas"]["code-scanning-ref"]; /** @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. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -73720,16 +80849,14 @@ export interface components { /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ "commit-ref": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests"?: string; - /** - * @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. - */ + "dependabot-alert-comma-separated-manifests": string; + /** @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. */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path"?: string; + "manifest-path": string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ @@ -73744,7 +80871,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort?: "created" | "updated"; + sort: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -73762,31 +80889,31 @@ export interface components { /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo"?: number; + "since-repo": number; /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ - "excluded-attributes"?: string; + "excluded-attributes": string; /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ - "start-index"?: number; + "start-index": number; /** @description Used for pagination: the number of results to return per page. */ - count?: number; + count: number; /** @description A unique identifier of the SCIM group. */ "scim-group-id": string; /** @description The unique identifier of the SCIM user. */ "scim-user-id": string; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: "desc" | "asc"; + order: "desc" | "asc"; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "since-repo-date"?: string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date"?: string; + "before-repo-date": string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred"?: "created" | "updated"; + "sort-starred": "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user"?: number; + "since-user": number; }; requestBodies: never; headers: { @@ -73807,39 +80934,47 @@ export interface components { }; pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - /** - * GitHub API Root - * @description Get Hypermedia links to resources accessible in GitHub's REST API - */ "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["root"]; }; }; }; }; - /** List global webhooks */ "enterprise-admin/list-global-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["global-hook"][]; @@ -73847,8 +80982,13 @@ export interface operations { }; }; }; - /** Create a global webhook */ "enterprise-admin/create-global-webhook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -73878,51 +81018,68 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Get a global webhook */ "enterprise-admin/get-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Delete a global webhook */ "enterprise-admin/delete-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a global webhook - * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. - */ "enterprise-admin/update-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -73951,46 +81108,60 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook-2"]; }; }; }; }; - /** - * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the webhook. - */ "enterprise-admin/ping-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List public keys */ "enterprise-admin/list-public-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "accessed"; /** @description Only show public keys accessed after the given time. */ since?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["public-key-full"][]; @@ -73998,29 +81169,36 @@ export interface operations { }; }; }; - /** Delete a public key */ "enterprise-admin/delete-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_ids: components["parameters"]["key-ids"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update LDAP mapping for a team - * @description Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping. - */ "enterprise-admin/update-ldap-mapping-for-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -74033,25 +81211,32 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ldap-mapping-team"]; }; }; }; }; - /** - * Sync LDAP mapping for a team - * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. - */ "enterprise-admin/sync-ldap-mapping-for-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { status?: string; @@ -74060,12 +81245,15 @@ export interface operations { }; }; }; - /** Update LDAP mapping for a user */ "enterprise-admin/update-ldap-mapping-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -74078,25 +81266,32 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ldap-mapping-user"]; }; }; }; }; - /** - * Sync LDAP mapping for a user - * @description Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready. - */ "enterprise-admin/sync-ldap-mapping-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { status?: string; @@ -74105,8 +81300,13 @@ export interface operations { }; }; }; - /** Create an organization */ "enterprise-admin/create-org": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -74122,18 +81322,24 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-simple"]; }; }; }; }; - /** Update an organization name */ "enterprise-admin/update-org-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -74146,6 +81352,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74155,27 +81364,41 @@ export interface operations { }; }; }; - /** List pre-receive environments */ "enterprise-admin/list-pre-receive-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "name"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"][]; }; }; }; }; - /** Create a pre-receive environment */ "enterprise-admin/create-pre-receive-environment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -74189,51 +81412,62 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** Get a pre-receive environment */ "enterprise-admin/get-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** - * Delete a pre-receive environment - * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ - */ "enterprise-admin/delete-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74247,15 +81481,15 @@ export interface operations { }; }; }; - /** - * Update a pre-receive environment - * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. - */ "enterprise-admin/update-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -74270,12 +81504,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74289,32 +81529,32 @@ export interface operations { }; }; }; - /** - * Start a pre-receive environment download - * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. - * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ - */ "enterprise-admin/start-pre-receive-environment-download": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74328,47 +81568,65 @@ export interface operations { }; }; }; - /** - * Get the download status for a pre-receive environment - * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. - */ "enterprise-admin/get-download-status-for-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; }; }; - /** List pre-receive hooks */ "enterprise-admin/list-pre-receive-hooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "name"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"][]; }; }; }; }; - /** Create a pre-receive hook */ "enterprise-admin/create-pre-receive-hook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -74394,48 +81652,68 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** Get a pre-receive hook */ "enterprise-admin/get-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** Delete a pre-receive hook */ "enterprise-admin/delete-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a pre-receive hook */ "enterprise-admin/update-pre-receive-hook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -74462,28 +81740,34 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-hook"]; }; }; }; }; - /** - * List personal access tokens - * @description Lists personal access tokens for all users, including admin users. - */ "enterprise-admin/list-personal-access-tokens": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"][]; @@ -74491,42 +81775,42 @@ export interface operations { }; }; }; - /** - * Delete a personal access token - * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. - */ "enterprise-admin/delete-personal-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the token. */ token_id: components["parameters"]["token-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Create a user - * @description If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. - * - * The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. - * - * If the login name or email address is already associated with an account, the server will return a `422` response. - */ "enterprise-admin/create-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { /** @description The user's username. */ login: string; - /** - * @description **Required for built-in authentication.** The user's email - * address. This parameter can be omitted when using CAS, LDAP, or SAML. - * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." - */ + /** @description **Required for built-in authentication.** The user's email + * address. This parameter can be omitted when using CAS, LDAP, or SAML. + * For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." */ email?: string; /** * @description Whether to set the user as suspended when the user is created. @@ -74539,37 +81823,45 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"]; }; }; }; }; - /** - * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#suspend-a-user) is often a better option. - * - * You can delete any user account except your own. - */ "enterprise-admin/delete-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update the username for a user */ "enterprise-admin/update-username-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -74582,6 +81874,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -74591,12 +81886,15 @@ export interface operations { }; }; }; - /** Create an impersonation OAuth token */ "enterprise-admin/create-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -74609,61 +81907,81 @@ export interface operations { responses: { /** @description Response when getting an existing impersonation OAuth token */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; /** @description Response when creating a new impersonation OAuth token */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; }; }; - /** Delete an impersonation OAuth token */ "enterprise-admin/delete-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; }; }; }; - /** - * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ "apps/create-from-manifest": { parameters: { + query?: never; + header?: never; path: { code: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"] & { client_id: string; @@ -74678,29 +81996,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a webhook configuration for an app - * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an app - * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -74714,29 +82036,35 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an app webhook - * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -74745,21 +82073,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for an app webhook - * @description Returns a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -74768,38 +82097,41 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an app webhook - * @description Redeliver a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List installation requests for the authenticated app - * @description Lists all the pending installation requests for the authenticated GitHub App. - */ "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of integration installation requests */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration-installation-request"][]; }; @@ -74808,26 +82140,28 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List installations for the authenticated app - * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * The permissions the installation has are included under the `permissions` key. - */ "apps/list-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; outdated?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description The permissions the installation has are included under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -74975,11 +82309,11 @@ export interface operations { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ permissions: { /** @@ -75162,12 +82496,10 @@ export interface operations { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -75249,21 +82581,23 @@ export interface operations { }; }; }; - /** - * Get an installation for the authenticated app - * @description Enables an authenticated GitHub App to find an installation's information using the installation id. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -75271,43 +82605,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)" endpoint. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/delete-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. - * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. - * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/create-installation-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -75317,8 +82645,8 @@ export interface operations { /** * @description List of repository IDs that the token should have access to * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -75328,6 +82656,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation-token"]; }; @@ -75338,67 +82669,71 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/suspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unsuspend an app installation - * @description Removes a GitHub App installation suspension. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/unsuspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List your grants - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. - */ "oauth-authorizations/list-grants": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The client ID of your GitHub app. */ client_id?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["application-grant"][]; @@ -75410,20 +82745,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a single grant - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-grant": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the grant. */ grant_id: components["parameters"]["grant-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["application-grant"]; }; @@ -75433,39 +82771,39 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a grant - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "oauth-authorizations/delete-grant": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the grant. */ grant_id: components["parameters"]["grant-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "apps/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75478,20 +82816,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. - */ "apps/check-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75504,6 +82845,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -75512,15 +82856,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. - */ "apps/delete-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75533,20 +82877,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ "apps/reset-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75559,6 +82906,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -75566,23 +82916,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a scoped access token - * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. - * - * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. - */ "apps/scope-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75607,8 +82949,8 @@ export interface operations { /** * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -75618,6 +82960,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -75628,19 +82973,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - */ "apps/get-by-slug": { parameters: { + query?: never; + header?: never; path: { app_slug: components["parameters"]["app-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; @@ -75649,25 +82997,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List your authorizations - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/list-authorizations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The client ID of your GitHub app. */ client_id?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"][]; @@ -75679,31 +83029,22 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a new authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. - * - * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use). - * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.9/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. - */ "oauth-authorizations/create-authorization": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -75728,6 +83069,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -75740,24 +83082,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get-or-create an authorization for a specific app - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-or-create-authorization-for-app": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the OAuth app. */ client_id: components["parameters"]["oauth-client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -75767,9 +83100,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -75790,6 +83123,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -75800,6 +83134,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -75811,23 +83146,16 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get-or-create an authorization for a specific app and fingerprint - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * **Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - */ "oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the OAuth app. */ client_id: components["parameters"]["oauth-client-id"]; fingerprint: string; }; + cookie?: never; }; requestBody: { content: { @@ -75837,9 +83165,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @@ -75858,6 +83186,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -75868,6 +83197,7 @@ export interface operations { headers: { /** @example https://api.github.com/authorizations/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"]; @@ -75876,20 +83206,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a single authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/get-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -75899,41 +83232,39 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete an authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - */ "oauth-authorizations/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Update an existing authorization - * @deprecated - * @description **Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." - * - * You can only send one of these scope keys at a time. - */ "oauth-authorizations/update-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the authorization. */ authorization_id: components["parameters"]["authorization-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -75941,9 +83272,9 @@ export interface operations { /** * @description A list of scopes that this authorization is in. * @example [ - * "public_repo", - * "user" - * ] + * "public_repo", + * "user" + * ] */ scopes?: string[] | null; /** @description A list of scopes to add to this authorization. */ @@ -75965,6 +83296,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -75972,14 +83306,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all codes of conduct - * @description Returns array of all GitHub's codes of conduct. - */ "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"][]; }; @@ -75987,19 +83327,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a code of conduct - * @description Returns information about the specified GitHub code of conduct. - */ "codes-of-conduct/get-conduct-code": { parameters: { + query?: never; + header?: never; path: { key: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"]; }; @@ -76008,54 +83351,74 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get emojis - * @description Lists all the emojis available to use on GitHub Enterprise Server. - */ "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { - [key: string]: string; + [key: string]: string | undefined; }; }; }; 304: components["responses"]["not_modified"]; }; }; - /** - * Get the global announcement banner - * @description Gets the current message and expiration date of the global announcement banner in your enterprise. - */ "enterprise-admin/get-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** - * Remove the global announcement banner - * @description Removes the global announcement banner in your enterprise. - */ "enterprise-admin/remove-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set the global announcement banner - * @description Sets the message and expiration time for the global announcement banner in your enterprise. - */ "enterprise-admin/set-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["announcement"]; @@ -76064,162 +83427,272 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** Get license information */ "enterprise-admin/get-license-information": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-info"]; }; }; }; }; - /** Get all statistics */ "enterprise-admin/get-all-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-overview"]; }; }; }; }; - /** Get comment statistics */ "enterprise-admin/get-comment-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-comment-overview"]; }; }; }; }; - /** Get gist statistics */ "enterprise-admin/get-gist-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-gist-overview"]; }; }; }; }; - /** Get hooks statistics */ "enterprise-admin/get-hooks-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-hook-overview"]; }; }; }; }; - /** Get issue statistics */ "enterprise-admin/get-issue-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-issue-overview"]; }; }; }; }; - /** Get milestone statistics */ "enterprise-admin/get-milestone-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-milestone-overview"]; }; }; }; }; - /** Get organization statistics */ "enterprise-admin/get-org-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-organization-overview"]; }; }; }; }; - /** Get pages statistics */ "enterprise-admin/get-pages-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-page-overview"]; }; }; }; }; - /** Get pull request statistics */ "enterprise-admin/get-pull-request-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-pull-request-overview"]; }; }; }; }; - /** Get repository statistics */ "enterprise-admin/get-repo-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-repository-overview"]; }; }; }; }; - /** Get users statistics */ "enterprise-admin/get-user-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-user-overview"]; }; }; }; }; - /** - * Get GitHub Actions cache usage for an enterprise - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -76227,23 +83700,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage policy for an enterprise - * @description Gets the GitHub Actions cache usage policy for an enterprise. - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-actions-cache-usage-policy-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-policy-enterprise"]; @@ -76251,17 +83724,15 @@ export interface operations { }; }; }; - /** - * Set GitHub Actions cache usage policy for an enterprise - * @description Sets the GitHub Actions cache usage policy for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-actions-cache-usage-policy-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76271,42 +83742,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Actions permissions for an enterprise - * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-enterprise-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an enterprise - * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76319,29 +83793,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -76351,17 +83831,15 @@ export interface operations { }; }; }; - /** - * Set selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76374,82 +83852,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected organization for GitHub Actions in an enterprise - * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/enable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected organization for GitHub Actions in an enterprise - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/disable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an enterprise - * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an enterprise - * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76459,46 +83946,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an enterprise - * @description 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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an enterprise - * @description 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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76508,30 +83994,37 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an enterprise - * @description Lists all self-hosted runner groups for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this organization. */ visible_to_organization?: components["parameters"]["visible-to-organization"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -76541,17 +84034,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an enterprise - * @description Creates a new self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -76585,66 +84076,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Get a self-hosted runner group for an enterprise - * @description Gets a specific self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an enterprise - * @description Deletes a self-hosted runner group for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an enterprise - * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -76675,32 +84174,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * List organization access to a self-hosted runner group in an enterprise - * @description Lists the organizations with access to a self-hosted runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -76710,18 +84216,17 @@ export interface operations { }; }; }; - /** - * Set organization access for a self-hosted runner group in an enterprise - * @description Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76734,74 +84239,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add organization access to a self-hosted runner group in an enterprise - * @description Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove organization access to a self-hosted runner group in an enterprise - * @description Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an enterprise - * @description Lists the self-hosted runners that are in a specific enterprise group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -76812,18 +84330,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an enterprise - * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -76836,73 +84353,85 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an enterprise - * @description Adds a self-hosted runner to a runner group configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an enterprise - * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an enterprise - * @description Lists all self-hosted runners configured for an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -76913,159 +84442,152 @@ export interface operations { }; }; }; - /** - * List runner applications for an enterprise - * @description Lists binaries for the runner application that you can download and run. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create a registration token for an enterprise - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. - * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-registration-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an enterprise - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. - * - * Example using remove token: - * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-remove-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an enterprise - * @description Gets a specific self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an enterprise - * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an enterprise - * @description Lists all labels for a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an enterprise - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77081,18 +84603,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an enterprise - * @description Add custom labels to a self-hosted runner configured in an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77108,114 +84629,128 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an enterprise - * @description Remove all custom labels from a self-hosted runner configured in an - * enterprise. Returns the remaining read-only labels from the runner. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an enterprise - * @description 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. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get the audit log for an enterprise - * @description Gets the audit log for an enterprise. - * - * The authenticated user must be an enterprise admin to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-enterprise-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an enterprise - * @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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. - */ "code-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -77225,23 +84760,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get code security and analysis features for an enterprise - * @description Gets code security and analysis settings for the specified enterprise. - * - * The authenticated user must be an administrator of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/get-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-security-analysis-settings"]; }; @@ -77249,19 +84784,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update code security and analysis features for an enterprise - * @description Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/patch-security-analysis-settings-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody?: { content: { @@ -77274,10 +84805,8 @@ export interface operations { secret_scanning_enabled_for_new_repositories?: boolean; /** @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/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; - /** - * @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/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." - * To disable this functionality, set this field to `null`. - */ + /** @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/enterprise-server@3.9/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + * To disable this functionality, set this field to `null`. */ secret_scanning_push_protection_custom_link?: string | null; }; }; @@ -77285,48 +84814,75 @@ export interface operations { responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * 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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. - */ "dependabot/list-alerts-for-enterprise": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -77337,32 +84893,42 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List secret scanning alerts for an enterprise - * @description 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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - */ "secret-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -77372,27 +84938,28 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get GitHub Advanced Security active committers for an enterprise - * @description 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. - */ "billing/get-github-advanced-security-billing-ghe": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; @@ -77400,48 +84967,61 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; }; }; - /** - * Enable or disable a security feature - * @description Enables or disables the specified security feature for all repositories in an enterprise. - * - * The authenticated user must be an administrator of the enterprise to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "secret-scanning/post-security-product-enablement-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["enterprise-security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the enterprise. + * `disable_all` means to disable the specified security feature for all repositories in the enterprise. */ enablement: components["parameters"]["enterprise-security-product-enablement"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. - */ "activity/list-public-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -77451,49 +85031,47 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get feeds - * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. - * - * * **Timeline**: The GitHub Enterprise Server global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub Enterprise Server. - * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. - */ "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["feed"]; }; }; }; }; - /** - * List gists for the authenticated user - * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: - */ "gists/list": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -77503,13 +85081,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a gist - * @description Allows you to add a new gist with one or more files. - * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - */ "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -77521,16 +85099,18 @@ export interface operations { /** * @description Names and content for the files that make up the gist * @example { - * "hello.rb": { - * "content": "puts \"Hello, World!\"" - * } - * } + * "hello.rb": { + * "content": "puts \"Hello, World!\"" + * } + * } */ files: { - [key: string]: { - /** @description Content of the file */ - content: string; - }; + [key: string]: + | { + /** @description Content of the file */ + content: string; + } + | undefined; }; public?: boolean | ("true" | "false"); }; @@ -77542,6 +85122,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"]; @@ -77553,25 +85134,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List public gists - * @description List public gists sorted by most recently updated to least recently updated. - * - * Note: With [pagination](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - */ "gists/list-public": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -77582,23 +85165,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List starred gists - * @description List the authenticated user's starred gists: - */ "gists/list-starred": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -77609,24 +85196,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a gist - * @description Gets a specified gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -77636,32 +85222,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist */ "gists/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist - * @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. - */ "gists/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77673,23 +85266,25 @@ export interface operations { description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. + * (including extension) of the targeted gist file. For example: `hello.py`. * - * To delete a file, set the whole file to null. For example: `hello.py : null`. + * To delete a file, set the whole file to null. For example: `hello.py : null`. * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } */ files?: { - [key: string]: { - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - }; + [key: string]: + | { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + } + | undefined; }; } | null; }; @@ -77697,6 +85292,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -77705,30 +85303,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List gist comments - * @description Lists the comments on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/list-comments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"][]; @@ -77739,20 +85335,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a gist comment - * @description Creates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77771,6 +85362,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"]; @@ -77781,25 +85373,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist comment - * @description Gets a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -77809,39 +85401,43 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist comment */ "gists/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist comment - * @description Updates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77857,6 +85453,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -77864,23 +85463,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist commits */ "gists/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-commit"][]; @@ -77891,22 +85496,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist forks */ "gists/list-forks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"][]; @@ -77917,19 +85528,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Fork a gist */ "gists/fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"]; @@ -77941,84 +85557,104 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Check if a gist is starred */ "gists/check-is-starred": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if gist is starred */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; }; }; - /** - * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "gists/star": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** Unstar a gist */ "gists/unstar": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist revision - * @description Gets a specified gist revision. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-revision": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -78028,14 +85664,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-the-authenticated-user). - */ "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -78043,23 +85685,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a gitignore template - * @description Get the content of a gitignore template. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. - */ "gitignore/get-template": { parameters: { + query?: never; + header?: never; path: { name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gitignore-template"]; }; @@ -78067,22 +85708,25 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * List repositories accessible to the app installation - * @description List repositories that an app installation can access. - */ "apps/list-repos-accessible-to-installation": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -78098,38 +85742,24 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Revoke an installation access token - * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. - * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - */ "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List issues assigned to the authenticated user - * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list": { parameters: { query?: { @@ -78143,24 +85773,34 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; collab?: boolean; orgs?: boolean; owned?: boolean; pulls?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -78171,21 +85811,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get-all-commonly-used": { parameters: { query?: { featured?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-simple"][]; }; @@ -78193,19 +85838,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get": { parameters: { + query?: never; + header?: never; path: { license: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license"]; }; @@ -78215,93 +85863,130 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GHES node metadata for all nodes - * @description Get node metadata for all configured nodes in the current cluster. For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/configuring-clustering/about-clustering)." - */ "enterprise-admin/get-config-nodes": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-config-nodes"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the status of services running on all replica nodes - * @description Gets the status of all services running on each replica node. - * This endpoint may take several seconds to reply. - */ "enterprise-admin/get-replication-status": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-replication-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get all GHES release versions for all nodes - * @description Gets the GitHub Enterprise Server release versions that are currently installed on all available nodes. For more information, see "[GitHub Enterprise Server releases](https://docs.github.com/enterprise-server@3.9/admin/all-releases)." - */ "enterprise-admin/get-version": { parameters: { query?: { + /** @description The UUID which identifies a node. */ uuid?: components["parameters"]["uuid"]; + /** @description The cluster roles from the cluster configuration file. */ cluster_roles?: components["parameters"]["cluster-roles"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ghes-version"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Internal error */ 500: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Render a Markdown document */ "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -78327,6 +86012,7 @@ export interface operations { /** @example 279 */ "Content-Length"?: string; "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -78335,11 +86021,13 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Render a Markdown document in raw mode - * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - */ "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "text/plain": string; @@ -78351,6 +86039,7 @@ export interface operations { 200: { headers: { "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -78359,11 +86048,20 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** Get GitHub Enterprise Server meta information */ "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["api-overview"]; }; @@ -78371,21 +86069,30 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ "activity/list-public-events-for-repo-network": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -78396,27 +86103,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List notifications for the authenticated user - * @description List all notifications for the current user, sorted by most recently updated. - */ "activity/list-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -78428,11 +86141,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -78449,6 +86164,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -78457,26 +86175,33 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread - * @description Gets information about a notification thread. - */ "activity/get-thread": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread"]; }; @@ -78486,40 +86211,46 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Mark a thread as read - * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. - */ "activity/mark-thread-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription). - * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - */ "activity/get-thread-subscription-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -78529,19 +86260,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Set a thread subscription - * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. - * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#delete-a-thread-subscription) endpoint. - */ "activity/set-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -78557,6 +86284,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -78566,65 +86296,73 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. - */ "activity/delete-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get Octocat - * @description Get the octocat as ASCII art - */ "meta/get-octocat": { parameters: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/octocat-stream": string; }; }; }; }; - /** - * List organizations - * @description Lists all organizations, in the order that they were created. - * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. - */ "orgs/list": { parameters: { query?: { + /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -78633,28 +86371,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Deprecated - List custom repository roles in an organization - * @deprecated - * @description **Note**: This operation is deprecated and will be removed in the future. - * Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. - * - * List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-roles": { parameters: { + query?: never; + header?: never; path: { /** @description The unique identifier of the organization. */ organization_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -78668,38 +86401,23 @@ export interface operations { }; }; }; - /** - * Get an organization - * @description Gets information about an organization. - * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.9/articles/securing-your-account-with-two-factor-authentication-2fa/). - * - * To see the full details about an organization, the authenticated user must be an organization owner. - * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. - * - * To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the `Organization plan` permission. - */ "orgs/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -78707,54 +86425,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization - * @description Deletes an organization and all its repositories. - * - * The organization login will be unavailable for 90 days after deletion. - * - * Please review the Terms of Service regarding account deletion before using this endpoint: - * - * https://docs.github.com/enterprise-server@3.9/site-policy/github-terms/github-terms-of-service - */ "orgs/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization - * @description **Parameter Deprecation Notice:** GitHub Enterprise Server 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). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/enterprise-server@3.9/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -78796,7 +86492,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -78817,53 +86513,41 @@ export interface operations { web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ blog?: string; - /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + /** @description Whether Dependabot alerts is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + /** @description Whether Dependabot security updates is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** - * @description Whether dependency graph is automatically enabled for new repositories. + /** @description Whether dependency graph is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning is automatically enabled for new repositories. + /** @description Whether secret scanning is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + /** @description Whether secret scanning push protection is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -78875,6 +86559,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -78882,6 +86569,9 @@ export interface operations { 409: components["responses"]["conflict"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -78890,24 +86580,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage for an organization - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -78915,28 +86604,28 @@ export interface operations { }; }; }; - /** - * List repositories with GitHub Actions cache usage for an organization - * @description Lists repositories and their 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-by-repo-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -78947,38 +86636,38 @@ export interface operations { }; }; }; - /** - * Get the customization template for an OIDC subject claim for an organization - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "oidc/get-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A JSON serialized template for OIDC subject claim customization */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub"]; }; }; }; }; - /** - * Set the customization template for an OIDC subject claim for an organization - * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "oidc/update-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -78988,6 +86677,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -78996,40 +86688,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GitHub Actions permissions for an organization - * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-organization-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an organization - * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -79042,29 +86732,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -79074,18 +86770,15 @@ export interface operations { }; }; }; - /** - * Set selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-selected-repositories-enabled-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -79098,86 +86791,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/enable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/disable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an organization - * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an organization - * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -79187,46 +86885,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an organization - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an organization - * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -79236,34 +86933,44 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an organization - * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runner-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this repository. */ visible_to_repository?: components["parameters"]["visible-to-repository"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -79273,17 +86980,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an organization - * @description Creates a new self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/create-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -79318,66 +87023,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Get a self-hosted runner group for an organization - * @description Gets a specific self-hosted runner group for an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an organization - * @description Deletes a self-hosted runner group for an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-group-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an organization - * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/update-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79407,32 +87120,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * List repository access to a self-hosted runner group in an organization - * @description Lists the repositories with access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-repo-access-to-self-hosted-runner-group-in-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -79442,18 +87162,17 @@ export interface operations { }; }; }; - /** - * Set repository access for a self-hosted runner group in an organization - * @description Replaces the list of repositories that have access to a self-hosted runner group configured in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79466,74 +87185,87 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add repository access to a self-hosted runner group in an organization - * @description Adds a repository to the list of repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove repository access to a self-hosted runner group in an organization - * @description Removes a repository from the list of selected repositories that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see "[Create a self-hosted runner group for an organization](#create-a-self-hosted-runner-group-for-an-organization)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-repo-access-to-self-hosted-runner-group-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners in a group for an organization - * @description Lists self-hosted runners that are in a specific organization group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runners-in-group-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79544,18 +87276,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an organization - * @description Replaces the list of self-hosted runners that are part of an organization runner group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-self-hosted-runners-in-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79568,75 +87299,85 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an organization - * @description Adds a self-hosted runner to a runner group configured in an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-self-hosted-runner-to-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an organization - * @description Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/remove-self-hosted-runner-from-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an organization - * @description Lists all self-hosted runners configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-self-hosted-runners-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79647,168 +87388,152 @@ export interface operations { }; }; }; - /** - * List runner applications for an organization - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-runner-applications-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create a registration token for an organization - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an organization - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an organization - * @description Gets a specific self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/get-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an organization - * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an organization - * @description Lists all labels for a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an organization - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-custom-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79824,20 +87549,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an organization - * @description Adds custom labels to a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79853,77 +87575,67 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an organization - * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an organization - * @description Remove a custom label from a self-hosted runner configured - * in an organization. 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. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-custom-label-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79934,138 +87646,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "actions/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -80087,61 +87726,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80151,22 +87798,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -80179,91 +87821,97 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization variables - * @description Lists all organization variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -80274,19 +87922,15 @@ export interface operations { }; }; }; - /** - * Create an organization variable - * @description Creates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80308,72 +87952,74 @@ export interface operations { responses: { /** @description Response when creating a variable */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an organization variable - * @description Gets a specific variable in an organization. - * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-variable"]; }; }; }; }; - /** - * Delete an organization variable - * @description Deletes an organization variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an organization variable - * @description Updates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/update-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -80395,33 +88041,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization variable - * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-variable": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80431,26 +88081,24 @@ export interface operations { }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set selected repositories for an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -80463,118 +88111,135 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get announcement banner for organization - * @description Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the - * organization level. Organization members may also see an enterprise-level announcement banner. To get an - * announcement banner displayed at the enterprise level, use the enterprise-level endpoint. - */ "announcement-banners/get-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Remove announcement banner from organization - * @description Removes the announcement banner currently set for the organization. - */ "announcement-banners/remove-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set announcement banner for organization - * @description Sets the announcement banner to display for the organization. - */ "announcement-banners/set-announcement-banner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80584,65 +88249,77 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement-banner"]; }; }; }; }; - /** - * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." - * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.9/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." - * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. - */ "orgs/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-phrase"]; + /** @description The event types to include: + * + * - `web` - returns web (non-Git) events. + * - `git` - returns Git events. + * - `all` - returns both web and Git events. + * + * The default is `web`. */ include?: components["parameters"]["audit-log-include"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-org": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; @@ -80651,15 +88328,20 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -80669,23 +88351,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List custom repository roles in an organization - * @description List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-custom-repo-roles": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of custom role names */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -80699,19 +88381,15 @@ export interface operations { }; }; }; - /** - * Create a custom repository role - * @description Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/create-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80721,6 +88399,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -80729,24 +88410,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a custom repository role - * @description Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/get-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -80754,43 +88436,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a custom repository role - * @description 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. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/delete-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a custom repository role - * @description Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/update-custom-repo-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80800,6 +88479,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-custom-repository-role"]; }; @@ -80808,37 +88490,60 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List Dependabot alerts for an organization - * @description Lists Dependabot alerts for an organization. - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-org": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -80850,28 +88555,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -80882,134 +88587,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "dependabot/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81031,57 +88667,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81091,20 +88739,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81117,79 +88762,92 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get list of conflicting packages during Docker migration for organization - * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -81198,73 +88856,84 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ "activity/list-public-org-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * Get an external group - * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/external-idp-group-info-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the group. */ group_id: components["parameters"]["group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List external groups in an organization - * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-external-idp-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description Page token */ page?: number; /** @description Limits the list to groups containing the text in the group name */ display_name?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["external-groups"]; @@ -81272,28 +88941,28 @@ export interface operations { }; }; }; - /** - * List organization webhooks - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"][]; @@ -81302,20 +88971,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization webhook - * @description Create a hook that posts payloads in JSON format. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -81336,8 +89000,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -81354,6 +89018,7 @@ export interface operations { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"]; @@ -81363,26 +89028,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -81390,47 +89054,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -81445,8 +89103,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -81462,6 +89120,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -81470,46 +89131,42 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for an organization - * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an organization - * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -81524,36 +89181,40 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an organization webhook - * @description Returns a list of webhook deliveries for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -81562,26 +89223,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook delivery for an organization webhook - * @description Returns a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -81590,99 +89251,95 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an organization webhook - * @description Redeliver a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) - * to be sent to the hook. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an organization installation for the authenticated app - * @description Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-org-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. - */ "orgs/list-app-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81693,22 +89350,6 @@ export interface operations { }; }; }; - /** - * List organization issues assigned to the authenticated user - * @description List issues in an organization assigned to the authenticated user. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-org": { parameters: { query?: { @@ -81722,23 +89363,33 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -81747,10 +89398,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization members - * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. - */ "orgs/list-members": { parameters: { query?: { @@ -81758,18 +89405,25 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -81778,69 +89432,88 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Check organization membership for a user - * @description Check if a user is, publicly or privately, a member of the organization. - */ "orgs/check-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if requester is an organization member and user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if requester is not an organization member */ 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization member - * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - */ "orgs/remove-member": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get organization membership for a user - * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. - */ "orgs/get-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -81849,32 +89522,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set organization membership for a user - * @description Only authenticated organization owners can add a member to the organization or update the member's role. - * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. - * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. - * - * **Rate limits** - * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. - */ "orgs/set-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. * @default member * @enum {string} */ @@ -81885,6 +89551,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -81893,51 +89562,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove organization membership for a user - * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - */ "orgs/remove-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List organization migrations - * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). - * - * A list of `repositories` is only returned for export migrations. - */ "migrations/list-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -81945,17 +89618,15 @@ export interface operations { }; }; }; - /** - * Start an organization migration - * @description Initiates the generation of a migration archive. - * - * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." - */ "migrations/start-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82010,6 +89681,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -82018,36 +89692,31 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization migration status - * @description Fetches the status of a migration. - * - * The `state` of a migration can be one of the following values: - * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ "migrations/get-status-for-org": { parameters: { query?: { /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** - * @description * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -82055,84 +89724,104 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download an organization migration archive - * @description Fetches the URL to a migration archive. - */ "migrations/download-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization migration archive - * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. - */ "migrations/delete-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. - */ "migrations/unlock-repo-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List repositories in an organization migration - * @description List all the repositories for this organization migration. - */ "migrations/list-repos-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -82141,27 +89830,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List outside collaborators for an organization - * @description List all users who are outside collaborators of an organization. - */ "orgs/list-outside-collaborators": { parameters: { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -82169,16 +89861,17 @@ export interface operations { }; }; }; - /** - * Convert an organization member to outside collaborator - * @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/enterprise-server@3.9/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-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." - */ "orgs/convert-member-to-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82194,39 +89887,56 @@ export interface operations { responses: { /** @description User is getting converted asynchronously */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description User was converted */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @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/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Remove outside collaborator from an organization - * @description Removing a user from this list will remove them from all the organization's repositories. - */ "orgs/remove-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -82236,12 +89946,6 @@ export interface operations { }; }; }; - /** - * List packages for an organization - * @description Lists packages in an organization readable by the user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-organization": { parameters: { query: { @@ -82253,19 +89957,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -82275,112 +89990,120 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for an organization - * @description Gets a specific package in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for an organization - * @description Restores an entire package in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-org": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by an organization - * @description Lists package versions for a package owned by an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -82390,161 +90113,188 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for an organization - * @description Gets a specific package version in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for an organization - * @description Restores a specific package version in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List pre-receive hooks for an organization - * @description List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed. - */ "enterprise-admin/list-pre-receive-hooks-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The sort order for the response collection. */ sort?: "created" | "updated" | "name"; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"][]; }; }; }; }; - /** Get a pre-receive hook for an organization */ "enterprise-admin/get-pre-receive-hook-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * Remove pre-receive hook enforcement for an organization - * @description Removes any overrides for this hook at the org level for this org. - */ "enterprise-admin/remove-pre-receive-hook-enforcement-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * Update pre-receive hook enforcement for an organization - * @description For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration` - */ "enterprise-admin/update-pre-receive-hook-enforcement-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82559,33 +90309,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-pre-receive-hook"]; }; }; }; }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-org": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -82594,15 +90350,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82617,6 +90373,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -82628,25 +90387,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public organization members - * @description Members of an organization can choose to have their membership publicized or not. - */ "orgs/list-public-members": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -82654,73 +90416,83 @@ export interface operations { }; }; }; - /** - * Check public organization membership for a user - * @description Check if the provided user is a public member of the organization. - */ "orgs/check-public-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a public member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a public member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set public organization membership for the authenticated user - * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "orgs/set-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Remove public organization membership for the authenticated user - * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. - */ "orgs/remove-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization repositories - * @description 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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/list-for-org": { parameters: { query?: { @@ -82737,18 +90509,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -82756,17 +90535,15 @@ export interface operations { }; }; }; - /** - * Create an organization repository - * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82784,7 +90561,7 @@ export interface operations { private?: boolean; /** * @description The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see "[Creating an internal repository](https://docs.github.com/enterprise-server@3.9/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. - * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. * @enum {string} */ visibility?: "public" | "private" | "internal"; @@ -82859,34 +90636,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -82899,6 +90676,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -82908,59 +90686,67 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." - * - * The authenticated user must be an administrator of the organization or of a repository of the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/list-repo-fine-grained-permissions": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-fine-grained-permission"][]; }; }; }; }; - /** - * List secret scanning alerts for an organization - * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-org": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -82970,100 +90756,104 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "orgs/list-security-manager-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - /** - * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/add-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The organization has reached the maximum number of security manager teams. */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/remove-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Advanced Security active committers for an organization - * @description 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. - */ "billing/get-github-advanced-security-billing-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["advanced-security-active-committers"]; }; @@ -83071,25 +90861,28 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; }; }; - /** - * List teams - * @description Lists all teams in an organization that are visible to the authenticated user. - */ "teams/list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -83098,17 +90891,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a team - * @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/enterprise-server@3.9/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/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/about-teams)". - */ "teams/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83123,13 +90914,13 @@ export interface operations { repo_names?: string[]; /** * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` * @enum {string} */ privacy?: "secret" | "closed"; @@ -83149,6 +90940,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -83157,22 +90951,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a team by name - * @description Gets a team using the team's `slug`. To create the `slug`, GitHub Enterprise Server replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. - */ "teams/get-by-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -83180,40 +90977,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team - * @description To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - */ "teams/delete-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a team - * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - */ "teams/update-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83224,11 +91021,11 @@ export interface operations { description?: string; /** * @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: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; @@ -83246,12 +91043,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -83261,33 +91064,34 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Pinned discussions only filter */ pinned?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -83295,22 +91099,17 @@ export interface operations { }; }; }; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -83330,75 +91129,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83413,38 +91217,43 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -83452,23 +91261,19 @@ export interface operations { }; }; }; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * **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`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83481,78 +91286,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83565,20 +91378,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { @@ -83592,21 +91400,31 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -83614,24 +91432,21 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83655,51 +91470,53 @@ export interface operations { responses: { /** @description Response when the reaction type has already been added to this team discussion comment */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { @@ -83713,20 +91530,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -83734,23 +91560,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83774,96 +91596,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List a connection between an external group and a team - * @description Lists a connection between a team and an external group. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-linked-external-idp-groups-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-groups"]; }; }; }; }; - /** - * Remove the connection between an external group and a team - * @description Deletes a connection between a team and an external group. - * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update the connection between an external group and a team - * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/link-external-idp-group-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -83879,36 +91715,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List team members - * @description Team members will include the members of child teams. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/list-members-in-org": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -83916,61 +91757,53 @@ export interface operations { }; }; }; - /** - * Get team membership for a user - * @description Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). - */ "teams/get-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ 404: { - content: never; - }; - }; - }; - /** - * Add or update team membership for a user - * @description 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/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. - * - * If 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. - * - * **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}`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-or-update-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83987,71 +91820,85 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user - * @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. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/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}`. - */ "teams/remove-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ "teams/list-projects-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -84059,46 +91906,53 @@ export interface operations { }; }; }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/check-permissions-for-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/add-or-update-project-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84114,10 +91968,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84127,49 +91987,55 @@ export interface operations { }; }; }; - /** - * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/remove-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team repositories - * @description Lists a team's repositories visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - */ "teams/list-repos-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -84177,60 +92043,64 @@ export interface operations { }; }; }; - /** - * Check team permissions for a repository - * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. - * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/check-permissions-for-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with repository permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team does not have permission for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions - * @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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **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/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". - */ "teams/add-or-update-repo-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84246,54 +92116,64 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a repository from a team - * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/remove-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams - * @description Lists the child teams of the team specified by `{team_slug}`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - */ "teams/list-child-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -84301,46 +92181,58 @@ export interface operations { }; }; }; - /** - * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ enablement: components["parameters"]["org-security-product-enablement"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a project card - * @description Gets information about a project card. - */ "projects/get-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -84351,25 +92243,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project card - * @description Deletes a project card - */ "projects/delete-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84381,12 +92280,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ "projects/update-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84407,6 +92309,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -84418,12 +92323,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ "projects/move-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84444,6 +92352,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -84452,6 +92363,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84468,6 +92382,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -84482,19 +92399,23 @@ export interface operations { }; }; }; - /** - * Get a project column - * @description Gets information about a project column. - */ "projects/get-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -84505,32 +92426,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project column - * @description Deletes a project column. - */ "projects/delete-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ "projects/update-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84546,6 +92474,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -84555,27 +92486,30 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List project cards - * @description Lists the project cards in a project. - */ "projects/list-cards": { parameters: { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-card"][]; @@ -84586,25 +92520,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ "projects/create-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** * @description The project card's note * @example Update all gems */ note: string | null; - }, - { + } + | { /** * @description The unique identifier of the content associated with the card * @example 42 @@ -84615,14 +92551,15 @@ export interface operations { * @example PullRequest */ content_type: string; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -84632,6 +92569,9 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -84640,6 +92580,9 @@ export interface operations { }; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -84654,12 +92597,15 @@ export interface operations { }; }; }; - /** Move a project column */ "projects/move-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84675,6 +92621,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -84685,19 +92634,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -84707,25 +92660,32 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ "projects/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Delete Success */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84738,15 +92698,15 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84779,6 +92739,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -84787,6 +92750,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84797,33 +92763,39 @@ export interface operations { }; /** @description Not Found if the authenticated user does not have access to the project */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 410: components["responses"]["gone"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ "projects/list-collaborators": { parameters: { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -84836,16 +92808,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ "projects/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84863,7 +92836,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -84872,21 +92848,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ "projects/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -84895,20 +92876,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ "projects/get-permission-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-collaborator-permission"]; }; @@ -84920,25 +92906,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List project columns - * @description Lists the project columns in a project. - */ "projects/list-columns": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-column"][]; @@ -84949,15 +92938,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a project column - * @description Creates a new project column. - */ "projects/create-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84973,6 +92962,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -84983,24 +92975,14 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. - * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/enterprise-server@3.9/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/enterprise-server@3.9/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.9/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.9/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/enterprise-server@3.9/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - */ "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -85008,6 +92990,7 @@ export interface operations { "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["rate-limit-overview"]; @@ -85017,22 +93000,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository - * @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. - * - * **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/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -85042,30 +93028,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a repository - * @description Deleting a repository requires admin access. - * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. - * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. - */ "repos/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -85076,16 +93065,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics) endpoint. - */ "repos/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85098,7 +93088,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -85107,16 +93097,14 @@ export interface operations { * @enum {string} */ visibility?: "public" | "private" | "internal"; - /** - * @description Specify which security and analysis features to enable or disable for the repository. + /** @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. * - * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { @@ -85190,34 +93178,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -85242,6 +93230,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -85252,31 +93243,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List artifacts for a repository - * @description Lists all artifacts for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-artifacts-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85287,137 +93279,147 @@ export interface operations { }; }; }; - /** - * Get an artifact - * @description Gets a specific artifact for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["artifact"]; }; }; }; }; - /** - * Delete an artifact - * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download an artifact - * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; archive_format: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { Location: components["headers"]["location"]; + [name: string]: unknown; }; - content: never; + content?: never; }; 410: components["responses"]["gone"]; }; }; - /** - * Get GitHub Actions cache usage for a repository - * @description Gets GitHub Actions cache usage for a repository. - * 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. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-by-repository"]; }; }; }; }; - /** - * Get GitHub Actions cache usage policy for a repository - * @description Gets GitHub Actions cache usage policy for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-policy-for-repository"]; }; }; }; }; - /** - * Set GitHub Actions cache usage policy for a repository - * @description Sets GitHub Actions cache usage policy for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-actions-cache-usage-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -85427,36 +93429,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List GitHub Actions caches for a repository - * @description Lists the GitHub Actions caches for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; + /** @description An explicit key or prefix for identifying the cache */ key?: components["parameters"]["actions-cache-key"]; + /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ sort?: components["parameters"]["actions-cache-list-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-list"]; @@ -85464,119 +93475,128 @@ export interface operations { }; }; }; - /** - * Delete GitHub Actions caches for a repository (using a cache key) - * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-key": { parameters: { query: { + /** @description A key for identifying the cache. */ key: components["parameters"]["actions-cache-key-required"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - /** - * Delete a GitHub Actions cache for a repository (using a cache ID) - * @description Deletes a GitHub Actions cache for a repository, using a cache ID. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-id": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the GitHub Actions cache. */ cache_id: components["parameters"]["cache-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a job for a workflow run - * @description Gets a specific job in a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["job"]; }; }; }; }; - /** - * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-job-logs-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Re-run a job from a workflow run - * @description Re-run a job and its dependent jobs in a workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85592,6 +93612,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -85599,22 +93622,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get the customization template for an OIDC subject claim for a repository - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub-repo"]; }; @@ -85623,18 +93649,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set the customization template for an OIDC subject claim for a repository - * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -85649,6 +93674,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -85658,31 +93686,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository organization secrets - * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85693,30 +93720,30 @@ export interface operations { }; }; }; - /** - * List repository organization variables - * @description Lists all organization variables shared with a repository. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85727,42 +93754,42 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions permissions for a repository - * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. - * - * You 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. - */ "actions/get-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-repository-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for a repository - * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. - * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -85775,50 +93802,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-workflow-access-to-repository"]; }; }; }; }; - /** - * Set the level of access for workflows outside of the repository - * @description 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 internal and private repositories. - * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.9/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)" and - * "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.9/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -85828,48 +93854,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for a repository - * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * You 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. - */ "actions/get-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for a repository - * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. - * - * To 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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85879,48 +93906,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for a repository - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for a repository - * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.9/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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -85930,38 +93958,44 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning organization or enterprise */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for a repository - * @description Lists all self-hosted runners configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85972,175 +94006,166 @@ export interface operations { }; }; }; - /** - * List runner applications for a repository - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-runner-applications-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for a repository - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for a repository - * @description Gets a specific self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from a repository - * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for a repository - * @description Lists all labels for a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for a repository - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86156,21 +94181,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for a repository - * @description Adds custom labels to a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86186,89 +94209,89 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for a repository - * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for a repository - * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. - * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-custom-label-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List workflow runs for a repository - * @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/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. - */ "actions/list-workflow-runs-for-repo": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86279,106 +94302,116 @@ export interface operations { }; }; }; - /** - * Get a workflow run - * @description Gets a specific workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * Delete a workflow run - * @description Deletes a specific workflow run. - * - * Anyone with write access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-reviews-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment-approvals"][]; }; }; }; }; - /** - * List workflow run artifacts - * @description Lists artifacts for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-run-artifacts": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86389,62 +94422,66 @@ export interface operations { }; }; }; - /** - * Get a workflow run attempt - * @description Gets a specific workflow run attempt. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run-attempt": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86456,52 +94493,56 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download workflow run attempt logs - * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-attempt-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Cancel a workflow run - * @description Cancels a workflow run using its `id`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -86509,34 +94550,34 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List jobs for a workflow run - * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run": { parameters: { query?: { /** @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. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86547,97 +94588,100 @@ export interface operations { }; }; }; - /** - * Download workflow run logs - * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Delete workflow run logs - * @description Deletes all logs for a workflow run. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Get pending deployments for a workflow run - * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pending-deployment"][]; }; }; }; }; - /** - * Review pending deployments for a workflow run - * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. - * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/review-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86645,9 +94689,9 @@ export interface operations { /** * @description The list of environment ids to approve or reject * @example [ - * 161171787, - * 161171795 - * ] + * 161171787, + * 161171795 + * ] */ environment_ids: number[]; /** @@ -86667,25 +94711,28 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"][]; }; }; }; }; - /** - * Re-run a workflow - * @description Re-runs your workflow run using its `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86701,25 +94748,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow-failed-jobs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86735,37 +94785,39 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86776,72 +94828,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -86856,63 +94907,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository variables - * @description Lists all repository variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86923,20 +94982,17 @@ export interface operations { }; }; }; - /** - * Create a repository variable - * @description Creates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -86951,75 +95007,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get a repository variable - * @description Gets a specific variable in a repository. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete a repository variable - * @description Deletes a repository variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a repository variable - * @description Updates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -87034,34 +95095,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository workflows - * @description Lists the workflows in a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-repo-workflows": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87072,68 +95136,71 @@ export interface operations { }; }; }; - /** - * Get a workflow - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow"]; }; }; }; }; - /** - * Disable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/disable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * 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`. - * - * You 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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-workflow-dispatch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87150,64 +95217,80 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/enable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow runs for a workflow - * @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/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-runs": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/enterprise-server@3.9/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/enterprise-server@3.9/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87218,26 +95301,30 @@ export interface operations { }; }; }; - /** - * List assignees - * @description Lists the [available assignees](https://docs.github.com/enterprise-server@3.9/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. - */ "issues/list-assignees": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -87246,67 +95333,75 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user can be assigned - * @description Checks if a user has permission to be assigned to an issue in this repository. - * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - * - * Otherwise a `404` status code is returned. - */ "issues/check-user-can-be-assigned": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Otherwise a `404` status code is returned. */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get all autolinks of a repository - * @description Gets all autolinks that are configured for a repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/list-autolinks": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"][]; }; }; }; }; - /** - * Create an autolink reference for a repository - * @description Users with admin access to the repository can create an autolink. - */ "repos/create-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87329,6 +95424,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["autolink"]; @@ -87337,23 +95433,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an autolink reference of a repository - * @description This returns a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/get-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"]; }; @@ -87361,47 +95461,58 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an autolink reference from a repository - * @description This deletes a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/delete-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** List branches */ "repos/list-branches": { parameters: { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-branch"][]; @@ -87410,18 +95521,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get a branch */ "repos/get-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -87430,21 +95550,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get branch protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-protection"]; }; @@ -87452,23 +95578,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update branch protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Protecting a branch requires admin or owner permissions to the repository. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. - */ "repos/update-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -87480,6 +95602,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -87559,6 +95682,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch"]; }; @@ -87568,148 +95694,178 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete branch protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get admin branch protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Set admin branch protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/set-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Delete admin branch protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/delete-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get pull request review protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - /** - * Delete pull request review protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update pull request review protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - */ "repos/update-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87749,6 +95905,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; @@ -87756,25 +95915,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get commit signature protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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/enterprise-server@3.9/articles/signing-commits-with-gpg) in GitHub Help. - * - * **Note**: You must enable branch protection to require signed commits. - */ "repos/get-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -87782,23 +95943,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create commit signature protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/create-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -87806,43 +95971,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete commit signature protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/delete-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get status checks protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-status-checks-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -87850,38 +96025,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove status check protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update status check protection - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/update-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87891,6 +96072,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -87906,6 +96088,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -87914,21 +96099,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all status check contexts - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-all-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -87936,17 +96127,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set status check contexts - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/set-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87959,6 +96152,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -87967,17 +96163,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add status check contexts - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/add-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87990,6 +96188,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -87999,17 +96200,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove status check contexts - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88022,6 +96225,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -88030,25 +96236,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists who has access to this protected branch. - * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. - */ "repos/get-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-restriction-policy"]; }; @@ -88056,44 +96264,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Disables the ability to restrict who can push to this branch. - */ "repos/delete-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get apps with access to the protected branch - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/get-apps-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -88101,19 +96317,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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/enterprise-server@3.9/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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/set-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88126,6 +96342,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -88133,19 +96352,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/add-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88158,6 +96377,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -88165,19 +96387,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/remove-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88190,6 +96412,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -88197,23 +96422,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get teams with access to the protected branch - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. The list includes child teams. - */ "repos/get-teams-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -88221,19 +96450,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - */ "repos/set-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88246,6 +96475,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -88253,19 +96485,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified teams push access for this branch. You can also give push access to child teams. - */ "repos/add-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88278,6 +96510,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -88285,19 +96520,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. - */ "repos/remove-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88310,6 +96545,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -88317,23 +96555,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get users with access to the protected branch - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - */ "repos/get-users-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -88341,23 +96583,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set user 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/set-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88370,6 +96608,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -88377,23 +96618,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add user 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified people push access for this branch. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/add-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88406,6 +96643,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -88413,23 +96653,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a user to push to this branch. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/remove-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88442,6 +96678,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -88449,23 +96688,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Rename a branch - * @description Renames a branch in a repository. - * - * **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/enterprise-server@3.9/github/administering-a-repository/renaming-a-branch)". - * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. - */ "repos/rename-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/enterprise-server@3.9/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -88478,6 +96713,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -88487,20 +96725,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. - * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - */ "checks/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88526,7 +96761,7 @@ export interface operations { started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ conclusion?: @@ -88600,149 +96835,153 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Get a check run - * @description Gets a single check run using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Update a check run - * @description Updates a check run for a specific commit in a repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The name of the check. For example, "code-coverage". */ - name?: string; - /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; - /** @description A reference for the run on the integrator's system. */ - external_id?: string; - /** - * Format: date-time - * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. - * @enum {string} - */ - status?: - | "queued" - | "in_progress" - | "completed" - | "waiting" - | "requested" - | "pending"; - /** - * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. - * @enum {string} - */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; - /** - * Format: date-time - * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - completed_at?: string; - /** @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. */ - output?: { - /** @description **Required**. */ - title?: string; - /** @description Can contain Markdown. */ - summary: string; - /** @description Can contain Markdown. */ - text?: string; - /** @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/enterprise-server@3.9/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.9/articles/about-status-checks#checks)". */ - annotations?: { - /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; - /** @description The start line of the annotation. Line numbers start at 1. */ - start_line: number; - /** @description The end line of the annotation. */ - end_line: number; - /** @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. */ - start_column?: number; - /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + "application/json": + | { + /** @description The name of the check. For example, "code-coverage". */ + name?: string; + /** @description The URL of the integrator's site that has the full details of the check. */ + details_url?: string; + /** @description A reference for the run on the integrator's system. */ + external_id?: string; /** - * @description The level of the annotation. + * Format: date-time + * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; - /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; - /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; - /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; - /** @description Adds images to the output displayed in the GitHub pull request UI. */ - images?: { - /** @description The alternative text for the image. */ - alt: string; - /** @description The full URL of the image. */ - image_url: string; - /** @description A short image description. */ - caption?: string; - }[]; - }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - actions?: { - /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; - /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; - /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - } & ( + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; + /** + * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * @enum {string} + */ + conclusion?: + | "action_required" + | "cancelled" + | "failure" + | "neutral" + | "success" + | "skipped" + | "stale" + | "timed_out"; + /** + * Format: date-time + * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** @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. */ + output?: { + /** @description **Required**. */ + title?: string; + /** @description Can contain Markdown. */ + summary: string; + /** @description Can contain Markdown. */ + text?: string; + /** @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/enterprise-server@3.9/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.9/articles/about-status-checks#checks)". */ + annotations?: { + /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** @description The start line of the annotation. Line numbers start at 1. */ + start_line: number; + /** @description The end line of the annotation. */ + end_line: number; + /** @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. */ + start_column?: number; + /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** + * @description The level of the annotation. + * @enum {string} + */ + annotation_level: "notice" | "warning" | "failure"; + /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** @description The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** @description Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + }[]; + /** @description Adds images to the output displayed in the GitHub pull request UI. */ + images?: { + /** @description The alternative text for the image. */ + alt: string; + /** @description The full URL of the image. */ + image_url: string; + /** @description A short image description. */ + caption?: string; + }[]; + }; + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + actions?: { + /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + }[]; + } | { /** @enum {unknown} */ status?: "completed"; @@ -88752,42 +96991,47 @@ export interface operations { /** @enum {unknown} */ status?: "queued" | "in_progress"; [key: string]: unknown; - } - ); + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-annotations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["check-annotation"][]; @@ -88795,31 +97039,36 @@ export interface operations { }; }; }; - /** - * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -88827,26 +97076,26 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites)". - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/create-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88859,29 +97108,35 @@ export interface operations { responses: { /** @description Response when the suite already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. - */ "checks/set-suites-preferences": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88902,66 +97157,74 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - /** - * Get a check suite - * @description Gets a single check suite using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-suite": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -88972,64 +97235,69 @@ export interface operations { }; }; }; - /** - * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List code scanning alerts for a repository - * @description Lists all open code scanning alerts for the default branch (usually `main` - * or `master`). 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. - * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch or for the specified Git reference - * (if you used `ref` in the request). - */ "code-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. . `number` is deprecated - we recommend that you use `created` instead. */ sort?: "created" | "number" | "updated"; /** @description Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ state?: components["schemas"]["code-scanning-alert-state"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-items"][]; }; @@ -89040,23 +97308,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning alert - * @description Gets a single code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -89067,18 +97339,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning alert - * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -89092,6 +97365,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -89101,28 +97377,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List instances of a code scanning alert - * @description Lists all instances of the specified code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alert-instances": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-instance"][]; }; @@ -89132,47 +97414,42 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List code scanning analyses for a repository - * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. - * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-recent-analyses": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the analyses 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`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"][]; }; @@ -89182,38 +97459,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning analysis for a repository - * @description Gets a specified code scanning analysis for a repository. - * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. - * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-analysis": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { @@ -89226,89 +97492,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. - * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/delete-analysis": { parameters: { query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ confirm_delete?: string | null; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; @@ -89319,22 +97526,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning default setup configuration - * @description Gets a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup"]; }; @@ -89344,18 +97554,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning default setup configuration - * @description Updates a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -89365,12 +97574,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; @@ -89381,47 +97596,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif)." - * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." - * - * You 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: - * - * ``` - * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." - * - * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/upload-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -89432,7 +97617,7 @@ export interface operations { /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. - * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ checkout_uri?: string; @@ -89449,40 +97634,53 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ 413: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ sarif_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; @@ -89490,54 +97688,49 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CODEOWNERS errors - * @description List any syntax errors that are detected in the CODEOWNERS - * file. - * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - */ "repos/codeowners-errors": { parameters: { query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository collaborators - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/list-collaborators": { parameters: { query?: { @@ -89545,19 +97738,27 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["collaborator"][]; @@ -89566,60 +97767,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is a repository collaborator - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/check-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a collaborator */ 404: { - content: never; - }; - }; - }; - /** - * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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-server@3.9/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/enterprise-server@3.9/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: - * - * ``` - * Cannot assign {member} permission of {role name} - * ``` - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **Updating an existing collaborator's permission level** - * - * The 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. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89633,81 +97825,68 @@ export interface operations { }; }; responses: { - /** - * @description Response when: - * - an existing collaborator is added as a collaborator - * - an organization member is added as an individual collaborator - * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator - */ + /** @description Response when: + * - an existing collaborator is added as a collaborator + * - an organization member is added as an individual collaborator + * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository collaborator - * @description Removes a collaborator from a repository. - * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. - * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages - * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. - * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". - */ "repos/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when collaborator was removed from the repository. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ "repos/get-collaborator-permission-level": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user has admin permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-collaborator-permission"]; }; @@ -89715,33 +97894,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit comments for a repository - * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-commit-comments-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -89749,28 +97925,27 @@ export interface operations { }; }; }; - /** - * Get a commit comment - * @description Gets a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/get-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -89778,41 +97953,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a commit comment */ "repos/delete-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a commit comment - * @description Updates the contents of a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/update-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89825,6 +98004,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -89832,10 +98014,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). - */ "reactions/list-for-commit-comment": { parameters: { query?: { @@ -89849,20 +98027,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -89871,17 +98058,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. - */ "reactions/create-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89905,12 +98094,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -89918,59 +98113,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment). - */ "reactions/delete-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List commits - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/list-commits": { parameters: { query?: { @@ -89982,22 +98151,31 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -90009,23 +98187,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List branches for HEAD commit - * @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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - */ "repos/list-branches-for-head-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-short"][]; }; @@ -90034,34 +98216,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List commit comments - * @description Lists the comments for a specified commit. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-comments-for-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -90069,26 +98249,19 @@ export interface operations { }; }; }; - /** - * Create a commit comment - * @description Create a comment for a commit using its `:commit_sha`. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/create-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; requestBody: { content: { @@ -90110,6 +98283,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"]; @@ -90119,29 +98293,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. - * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. - */ "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -90150,62 +98327,32 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a commit - * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/get-commit": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; @@ -90217,38 +98364,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-ref": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; app_id?: number; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90259,14 +98407,6 @@ export interface operations { }; }; }; - /** - * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-suites-for-ref": { parameters: { query?: { @@ -90275,21 +98415,31 @@ export interface operations { * @example 1 */ app_id?: number; + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90300,32 +98450,32 @@ export interface operations { }; }; }; - /** - * Get the combined status for a specific reference - * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - * - * - * Additionally, a combined `state` is returned. The `state` is one of: - * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` - */ "repos/get-combined-status-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-commit-status"]; }; @@ -90333,29 +98483,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit statuses for a reference - * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - */ "repos/list-commit-statuses-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"][]; @@ -90364,75 +98517,32 @@ export interface operations { 301: components["responses"]["moved_permanently"]; }; }; - /** - * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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/enterprise-server@3.9/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. - * - * **Working with large comparisons** - * - * 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. - * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api)." - * - * **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: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits-with-basehead": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @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`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; @@ -90442,50 +98552,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. - * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. - * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - * - * **Notes**: - * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/enterprise-server@3.9/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. - */ "repos/get-content": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/vnd.github.object": components["schemas"]["content-tree"]; "application/json": @@ -90500,22 +98590,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. - * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. - */ "repos/create-or-update-file-contents": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -90552,12 +98639,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -90567,26 +98660,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a file - * @description Deletes a file in a repository. - * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - */ "repos/delete-file": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -90617,6 +98703,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -90627,30 +98716,32 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository contributors - * @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. - * - * 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. - */ "repos/list-contributors": { parameters: { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If repository contains content */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["contributor"][]; @@ -90658,26 +98749,41 @@ export interface operations { }; /** @description Response if repository is empty */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List Dependabot alerts for a repository - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-repo": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** * @deprecated @@ -90689,19 +98795,35 @@ export interface operations { * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"][]; }; @@ -90713,21 +98835,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a Dependabot alert - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -90737,26 +98868,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The state of the Dependabot alert. - * A `dismissed_reason` must be provided when setting the state to `dismissed`. + * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ state: "dismissed" | "open"; @@ -90778,6 +98912,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -90789,29 +98926,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90822,67 +98960,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. - */ "dependabot/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -90897,58 +99039,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a diff of the dependencies between commits - * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. - */ "dependency-graph/diff-range": { parameters: { query?: { + /** @description The full path, relative to the repository root, of the dependency manifest file. */ name?: components["parameters"]["manifest-path"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-diff"]; @@ -90958,22 +99113,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Export a software bill of materials (SBOM) for a repository. - * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. - */ "dependency-graph/export-sbom": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; @@ -90983,20 +99141,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. - * - * The authenticated user must have access to the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependency-graph/create-repository-snapshot": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91006,6 +99161,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description ID of the created snapshot. */ @@ -91021,10 +99179,6 @@ export interface operations { }; }; }; - /** - * List deployments - * @description Simple filtering of deployments is available via query parameters: - */ "repos/list-deployments": { parameters: { query?: { @@ -91035,20 +99189,28 @@ export interface operations { /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment"][]; @@ -91056,63 +99218,17 @@ export interface operations { }; }; }; - /** - * Create a deployment - * @description Deployments offer a few configurable parameters with certain defaults. - * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server we often deploy branches and verify them - * before we merge a pull request. - * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. - * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. - * - * By default, [commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. - * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. - * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. - * - * Merged branch response: - * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts - * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. - * - * Merge conflict response: - * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * Failed commit status checks: - * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91131,14 +99247,11 @@ export interface operations { auto_merge?: boolean; /** @description The [status](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; - payload?: OneOf< - [ - { + payload?: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production @@ -91162,12 +99275,18 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -91176,23 +99295,35 @@ export interface operations { }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** Get a deployment */ "repos/get-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; @@ -91200,57 +99331,59 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * To set a deployment as inactive, you must: - * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. - * - * For more information, see "[Create a deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#create-a-deployment-status)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/delete-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List deployment statuses - * @description Users with pull access can view deployment statuses for a deployment: - */ "repos/list-deployment-statuses": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"][]; @@ -91259,19 +99392,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a deployment status - * @description Users with `push` access can create deployment statuses for a given deployment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91321,6 +99454,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"]; @@ -91329,22 +99463,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a deployment status - * @description Users with pull access can view a deployment status for a deployment: - */ "repos/get-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; status_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-status"]; }; @@ -91352,22 +99492,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#repository_dispatch)." - * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-dispatch-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91384,34 +99519,39 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List environments - * @description Lists the environments for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -91425,48 +99565,46 @@ export interface operations { }; }; }; - /** - * Get an environment - * @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)." - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; }; }; - /** - * Create or update an environment - * @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)." - * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-or-update-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -91490,60 +99628,75 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Delete an environment - * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-an-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List deployment branch policies - * @description Lists the deployment branch policies for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-deployment-branch-policies": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -91557,19 +99710,19 @@ export interface operations { }; }; }; - /** - * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -91579,60 +99732,73 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ 303: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91642,60 +99808,68 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91706,75 +99880,77 @@ export interface operations { }; }; }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -91789,65 +99965,75 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91858,21 +100044,19 @@ export interface operations { }; }; }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -91887,78 +100071,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -91973,53 +100165,69 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - */ "activity/list-repo-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List forks */ "repos/list-forks": { parameters: { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -92028,20 +100236,17 @@ export interface operations { 400: components["responses"]["bad_request"]; }; }; - /** - * Create a fork - * @description Create a fork for the authenticated user. - * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. - */ "repos/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92058,6 +100263,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -92068,13 +100276,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Create a blob */ "git/create-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92095,6 +100307,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-blob"]; @@ -92106,28 +100319,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a blob - * @description The `content` in the response will always be Base64 encoded. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. - * - * **Note** This endpoint supports blobs up to 100 megabytes in size. - */ "git/get-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; file_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["blob"]; }; @@ -92138,45 +100349,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a commit - * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92222,6 +100405,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-commit"]; @@ -92232,52 +100416,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a commit object - * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-commit"]; }; @@ -92286,29 +100445,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List matching references - * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - */ "git/list-matching-refs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"][]; @@ -92317,23 +100477,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a reference - * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - */ "git/get-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -92342,16 +100509,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a reference - * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. - */ "git/create-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92369,6 +100537,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"]; @@ -92378,38 +100547,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a reference - * @description Deletes the provided reference. - */ "git/delete-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a reference - * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - */ "git/update-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; requestBody: { content: { @@ -92427,6 +100610,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -92435,45 +100621,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.9/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92510,6 +100668,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tag"]; @@ -92519,48 +100678,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tag - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; tag_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tag"]; }; @@ -92569,20 +100706,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a tree - * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/enterprise-server@3.9/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference)." - * - * Returns an error if you try to delete a file that does not exist. - */ "git/create-tree": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92601,23 +100735,18 @@ export interface operations { * @enum {string} */ type?: "blob" | "tree" | "commit"; - /** - * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + /** @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ sha?: string | null; - /** - * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + /** @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ content?: string; }[]; - /** - * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - */ + /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + * */ base_tree?: string; }; }; @@ -92628,6 +100757,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tree"]; @@ -92639,31 +100769,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tree - * @description Returns a single tree using the SHA1 value or ref name for that tree. - * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. - */ "git/get-tree": { parameters: { query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ recursive?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tree"]; }; @@ -92673,26 +100802,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository webhooks - * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. - */ "repos/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"][]; @@ -92701,17 +100834,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository webhook - * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. - */ "repos/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92728,8 +100861,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -92746,6 +100879,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"]; @@ -92756,21 +100890,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." - */ "repos/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -92778,34 +100918,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ "repos/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." - */ "repos/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -92814,8 +100965,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ @@ -92833,6 +100984,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -92841,42 +100995,46 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. - */ "repos/get-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. - */ "repos/update-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92891,32 +101049,42 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for a repository webhook - * @description Returns a list of webhook deliveries for a webhook configured in a repository. - */ "repos/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -92925,22 +101093,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for a repository webhook - * @description Returns a delivery for a webhook configured in a repository. - */ "repos/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -92949,83 +101123,99 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for a repository webhook - * @description Redeliver a webhook delivery for a webhook configured in a repository. - */ "repos/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/enterprise-server@3.9/webhooks/#ping-event) to be sent to the hook. - */ "repos/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Test the push repository webhook - * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - */ "repos/test-push-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository installation for the authenticated app - * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-repo-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -93034,26 +101224,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repository invitations - * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. - */ "repos/list-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -93061,30 +101255,44 @@ export interface operations { }; }; }; - /** Delete a repository invitation */ "repos/delete-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a repository invitation */ "repos/update-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93100,28 +101308,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - /** - * List repository issues - * @description List issues in a repository. Only open issues will be listed. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-repo": { parameters: { query?: { @@ -93135,24 +101330,35 @@ export interface operations { creator?: string; /** @description A user that's mentioned in the issue. */ mentioned?: string; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -93163,26 +101369,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.9/articles/disabling-issues/), the API returns a `410 Gone` status. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93193,19 +101390,17 @@ export interface operations { body?: string; /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ assignee?: string | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; }; @@ -93217,6 +101412,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"]; @@ -93230,39 +101426,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List issue comments for a repository - * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. - * - * By default, issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments-for-repo": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -93272,28 +101465,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue comment - * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -93301,43 +101493,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an issue comment - * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - */ "issues/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an issue comment - * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -93350,6 +101543,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -93357,10 +101553,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). - */ "reactions/list-for-issue-comment": { parameters: { query?: { @@ -93374,20 +101566,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -93396,17 +101597,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. - */ "reactions/create-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -93430,12 +101633,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -93443,48 +101652,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment). - */ "reactions/delete-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List issue events for a repository - * @description Lists events for a repository. - */ "issues/list-events-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event"][]; @@ -93493,21 +101711,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue event - * @description Gets a single event by the event id. - */ "issues/get-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; event_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-event"]; }; @@ -93517,38 +101740,27 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/enterprise-server@3.9/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 - * 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/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -93559,30 +101771,25 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update an issue - * @description Issue owners and users with push access can edit an issue. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** @description The title of the issue. */ - title?: string | number | null; + title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; /** @description Username to assign to this issue. **This field is deprecated.** */ @@ -93598,19 +101805,17 @@ export interface operations { * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; }; @@ -93619,6 +101824,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -93631,17 +101839,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Add assignees to an issue - * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - */ "issues/add-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93654,23 +101864,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Remove assignees from an issue - * @description Removes one or more assignees from an issue. - */ "issues/remove-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -93683,73 +101898,78 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Check if a user can be assigned to a issue - * @description 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. - */ "issues/check-user-can-be-assigned-to-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List issue comments - * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * Issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -93759,29 +101979,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create an issue comment - * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -93797,6 +102007,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"]; @@ -93808,27 +102019,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List issue events - * @description Lists all events for an issue. - */ "issues/list-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event-for-issue"][]; @@ -93837,27 +102053,32 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * List labels for an issue - * @description Lists all labels for an issue. - */ "issues/list-labels-on-issue": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -93868,38 +102089,40 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Set labels for an issue - * @description Removes any previous labels and sets the new labels for an issue. - */ "issues/set-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -93910,38 +102133,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. - */ "issues/add-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -93952,44 +102177,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all labels from an issue - * @description Removes all labels from an issue. - */ "issues/remove-all-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 301: components["responses"]["moved_permanently"]; 404: components["responses"]["not_found"]; 410: components["responses"]["gone"]; }; }; - /** - * Remove a label from an issue - * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. - */ "issues/remove-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -93999,29 +102236,29 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Lock an issue - * @description Users with push access can lock an issue or pull request's conversation. - * - * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "issues/lock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` * @enum {string} */ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; @@ -94031,7 +102268,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -94039,31 +102279,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unlock an issue - * @description Users with push access can unlock an issue's conversation. - */ "issues/unlock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). - */ "reactions/list-for-issue": { parameters: { query?: { @@ -94077,20 +102319,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -94100,17 +102351,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. - */ "reactions/create-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -94134,12 +102387,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -94147,49 +102406,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - * - * Delete a reaction to an [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue). - */ "reactions/delete-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List timeline events for an issue - * @description List all timeline events for an issue. - */ "issues/list-events-for-timeline": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["timeline-issue-events"][]; @@ -94199,23 +102468,30 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** List deploy keys */ "repos/list-deploy-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"][]; @@ -94223,16 +102499,17 @@ export interface operations { }; }; }; - /** - * Create a deploy key - * @description You can create a read-only deploy key. - */ "repos/create-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94241,11 +102518,9 @@ export interface operations { title?: string; /** @description The contents of the key. */ key: string; - /** - * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + /** @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.9/articles/permission-levels-for-a-user-account-repository/)." - */ + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.9/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; }; @@ -94256,6 +102531,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"]; @@ -94264,18 +102540,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get a deploy key */ "repos/get-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deploy-key"]; }; @@ -94283,45 +102568,55 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a deploy key - * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. - */ "repos/delete-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a repository - * @description Lists all labels for a repository. - */ "issues/list-labels-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -94330,16 +102625,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a label - * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). - */ "issues/create-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94359,6 +102655,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"]; @@ -94368,21 +102665,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a label - * @description Gets a label using the given name. - */ "issues/get-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; @@ -94390,36 +102692,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a label - * @description Deletes a label using the given label name. - */ "issues/delete-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a label - * @description Updates a label using the given label name. - */ "issues/update-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; requestBody?: { content: { @@ -94436,98 +102744,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; }; }; }; - /** - * List repository languages - * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. - */ "repos/list-languages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["language"]; }; }; }; }; - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/enable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; - /** - * @description We will return a 403 with one of the following messages: + /** @description We will return a 403 with one of the following messages: * - * - Git LFS support not enabled because Git LFS is globally disabled. - * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - * - Git LFS support not enabled because Git LFS is disabled for . - */ + * - Git LFS support not enabled because Git LFS is globally disabled. + * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + * - Git LFS support not enabled because Git LFS is disabled for . */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. - */ "repos/disable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the license for a repository - * @description This method returns the contents of the repository's license file, if one is detected. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "licenses/get-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-content"]; }; @@ -94535,16 +102855,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Sync a fork branch with the upstream repository - * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. - */ "repos/merge-upstream": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94557,27 +102878,40 @@ export interface operations { responses: { /** @description The branch has been successfully synced with the upstream repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The branch could not be synced for some other reason */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Merge a branch */ "repos/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94594,30 +102928,38 @@ export interface operations { responses: { /** @description Successful Response (The resulting merge commit) */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when there is a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * List milestones - * @description Lists milestones for a repository. - */ "issues/list-milestones": { parameters: { query?: { @@ -94627,19 +102969,27 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"][]; @@ -94648,16 +102998,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a milestone - * @description Creates a milestone. - */ "issues/create-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94686,6 +103037,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"]; @@ -94695,21 +103047,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a milestone - * @description Gets a milestone using the given milestone number. - */ "issues/get-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; @@ -94717,34 +103075,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a milestone - * @description Deletes a milestone using the given milestone number. - */ "issues/delete-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** Update a milestone */ "issues/update-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94770,33 +103139,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; }; }; }; - /** - * List labels for issues in a milestone - * @description Lists labels for issues in a milestone. - */ "issues/list-labels-for-milestone": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -94804,30 +103181,38 @@ export interface operations { }; }; }; - /** - * List repository notifications for the authenticated user - * @description Lists all notifications for the current user in the specified repository. - */ "activity/list-repo-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -94835,16 +103220,17 @@ export interface operations { }; }; }; - /** - * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-repo-notifications-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94860,6 +103246,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94869,26 +103258,32 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a GitHub Enterprise Server Pages site - * @description Gets information about a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -94896,97 +103291,109 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update information about a GitHub Enterprise Server Pages site - * @description Updates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-information-about-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.9/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @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. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: - | ("gh-pages" | "master" | "master /docs") - | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - }; + "application/json": + | { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.9/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @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. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: + | ("gh-pages" | "master" | "master /docs") + | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + } + | unknown + | unknown + | unknown + | unknown + | unknown; }; }; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["bad_request"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a GitHub Enterprise Server Pages site - * @description Configures a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } | null; + "application/json": + | ( + | { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } + | unknown + | unknown + ) + | null; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -94995,53 +103402,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a GitHub Enterprise Server Pages site - * @description Deletes a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List GitHub Enterprise Server Pages builds - * @description Lists builts of a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/list-pages-builds": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["page-build"][]; @@ -95049,85 +103459,93 @@ export interface operations { }; }; }; - /** - * Request a GitHub Enterprise Server Pages build - * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - */ "repos/request-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - /** - * Get latest Pages build - * @description Gets information about the single most recent build of a GitHub Enterprise Server Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-latest-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Get GitHub Enterprise Server Pages build - * @description Gets information about a GitHub Enterprise Server Pages build. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; build_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Create a GitHub Pages deployment - * @description Create a GitHub Pages deployment for a repository. - * - * The authenticated user must have write permission to the repository. - */ "repos/create-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95152,6 +103570,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-deployment"]; }; @@ -95161,84 +103582,106 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pre-receive hooks for a repository - * @description List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed. - */ "enterprise-admin/list-pre-receive-hooks-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "name"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"][]; }; }; }; }; - /** Get a pre-receive hook for a repository */ "enterprise-admin/get-pre-receive-hook-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * Remove pre-receive hook enforcement for a repository - * @description Deletes any overridden enforcement on this repository for the specified hook. - * - * Responds with effective values inherited from owner and/or global level. - */ "enterprise-admin/remove-pre-receive-hook-enforcement-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Responds with effective values inherited from owner and/or global level. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * Update pre-receive hook enforcement for a repository - * @description For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement` - */ "enterprise-admin/update-pre-receive-hook-enforcement-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the pre-receive hook. */ pre_receive_hook_id: components["parameters"]["pre-receive-hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95254,34 +103697,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-pre-receive-hook"]; }; }; }; }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-repo": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -95294,16 +103744,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95318,6 +103769,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -95329,23 +103783,6 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List pull requests - * @description Lists pull requests in a specified repository. - * - * 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/enterprise-server@3.9/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list": { parameters: { query?: { @@ -95359,19 +103796,27 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -95381,27 +103826,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95439,6 +103874,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request"]; @@ -95448,38 +103884,35 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments-for-repo": { parameters: { query?: { sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -95487,28 +103920,27 @@ export interface operations { }; }; }; - /** - * Get a review comment for a pull request - * @description Provides details for a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; @@ -95516,44 +103948,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a review comment for a pull request - * @description Deletes a review comment. - */ "pulls/delete-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a review comment for a pull request - * @description Edits the content of a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95566,16 +103999,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - /** - * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { @@ -95589,20 +104021,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -95611,17 +104052,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. - */ "reactions/create-for-pull-request-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95645,12 +104088,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -95658,65 +104107,54 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - * - * Delete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/delete-for-pull-request-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Get a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists details of a pull request by providing its number. - * - * When you get, [create](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * - * * If merged as a [merge commit](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/enterprise-server@3.9/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - * - * Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "pulls/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -95728,26 +104166,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95771,6 +104202,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -95779,39 +104213,38 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments on a pull request - * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -95819,31 +104252,19 @@ export interface operations { }; }; }; - /** - * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment)." - * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -95892,6 +104313,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -95901,28 +104323,21 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a reply for a review comment - * @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. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-reply-for-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95938,6 +104353,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -95946,36 +104362,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits) - * endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -95983,37 +104395,32 @@ export interface operations { }; }; }; - /** - * List pull requests files - * @description Lists the files in a specified pull request. - * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-files": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["diff-entry"][]; @@ -96024,41 +104431,51 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Check if a pull request has been merged - * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. - */ "pulls/check-if-merged": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if pull request has been merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if pull request has not been merged */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Merge a pull request - * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - */ "pulls/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96080,6 +104497,9 @@ export interface operations { responses: { /** @description if merge was successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-merge-result"]; }; @@ -96088,6 +104508,9 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ 405: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -96097,6 +104520,9 @@ export interface operations { }; /** @description Conflict if sha was provided and pull request head did not match */ 409: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -96107,23 +104533,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. - */ "pulls/list-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-request"]; @@ -96131,17 +104561,19 @@ export interface operations { }; }; }; - /** - * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - */ "pulls/request-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96156,6 +104588,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -96163,21 +104598,26 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove requested reviewers from a pull request - * @description Removes review requests from a pull request for a given set of users and/or teams. - */ "pulls/remove-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -96192,6 +104632,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -96199,34 +104642,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reviews for a pull request - * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-reviews": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The list of reviews returns in chronological order. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review"][]; @@ -96234,32 +104675,19 @@ export interface operations { }; }; }; - /** - * Create a review for a pull request - * @description Creates a review on a specified pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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/enterprise-server@3.9/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#get-a-pull-request) endpoint. - * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96296,6 +104724,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -96304,29 +104735,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a review for a pull request - * @description Retrieves a pull request review by its ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -96334,25 +104765,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a review for a pull request - * @description Updates the contents of a specified review summary comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96365,6 +104792,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -96372,29 +104802,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete a pending review for a pull request - * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/delete-pending-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -96403,35 +104833,34 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List comments for a pull request review - * @description Lists comments for a specific pull request review. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-comments-for-review": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["review-comment"][]; @@ -96440,29 +104869,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Dismiss a review for a pull request - * @description Dismisses a specified review on a pull request. - * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/dismiss-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96480,6 +104901,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -96488,25 +104912,21 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#create-a-review-for-a-pull-request)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/submit-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96524,6 +104944,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -96533,17 +104956,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Update a pull request branch - * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - */ "pulls/update-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96556,6 +104981,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -96567,29 +104995,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README - * @description Gets the preferred README for a repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -96598,31 +105025,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README for a directory - * @description Gets the README from a repository directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme-in-directory": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ dir: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -96631,28 +105057,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repository-tags). - * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - */ "repos/list-releases": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"][]; @@ -96661,18 +105089,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a release - * @description Users with push access to the repository can create a release. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - */ "repos/create-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96715,6 +105142,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"]; @@ -96723,21 +105151,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. - */ "repos/get-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; @@ -96746,33 +105180,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a release asset */ "repos/delete-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release asset - * @description Users with push access to the repository can edit a release asset. - */ "repos/update-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96789,22 +105234,26 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; }; }; - /** - * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. - */ "repos/generate-release-notes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96823,6 +105272,9 @@ export interface operations { responses: { /** @description Name and body of generated release notes */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-notes-content"]; }; @@ -96830,44 +105282,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the latest release - * @description View the latest published full release for the repository. - * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - */ "repos/get-latest-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** - * Get a release by tag name - * @description Get a published release with the specified tag. - */ "repos/get-release-by-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description tag parameter */ tag: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; @@ -96875,65 +105335,78 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a release - * @description Gets a public release with the specified release ID. - * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - */ "repos/get-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a release - * @description Users with push access to the repository can delete a release. - */ "repos/delete-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release - * @description Users with push access to the repository can edit a release. - */ "repos/update-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96962,30 +105435,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** List release assets */ "repos/list-release-assets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release-asset"][]; @@ -96993,39 +105477,22 @@ export interface operations { }; }; }; - /** - * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#create-a-release) to upload a release asset. - * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - * - * `application/zip` - * - * GitHub Enterprise Server expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. - * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. - * - * **Notes:** - * * GitHub Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/enterprise-server@3.9/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. - */ "repos/upload-release-asset": { parameters: { query: { name: string; label?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97035,39 +105502,50 @@ export interface operations { responses: { /** @description Response for successful upload */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). - */ "reactions/list-for-release": { parameters: { query?: { /** @description Returns a single [reaction type](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -97076,17 +105554,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. - */ "reactions/create-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97102,12 +105582,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -97115,48 +105601,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - * - * Delete a reaction to a [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases#get-a-release). - */ "reactions/delete-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository cache replication status - * @description Lists the status of each repository cache replica. - */ "repos/list-cache-info": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status information for cache replicas */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -97175,65 +105670,81 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List secret scanning alerts for a repository - * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a secret scanning alert - * @description Gets a single secret scanning alert detected in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; @@ -97241,26 +105752,27 @@ export interface operations { 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a secret scanning alert - * @description Updates the status of a secret scanning alert in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -97274,50 +105786,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description State does not match the resolution or resolution comment */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List locations for a secret scanning alert - * @description Lists all locations for a given secret scanning alert for an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-locations-for-alert": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["secret-scanning-location"][]; @@ -97325,35 +105850,38 @@ export interface operations { }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List stargazers - * @description Lists the people that have starred the repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-stargazers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -97364,20 +105892,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the weekly commit activity - * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - */ "repos/get-code-frequency-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -97386,20 +105919,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the last year of commit activity - * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. - */ "repos/get-commit-activity-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-activity"][]; }; @@ -97408,26 +105946,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get all contributor commit activity - * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits - */ "repos/get-contributors-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["contributor-activity"][]; }; @@ -97436,24 +105973,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the weekly commit count - * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - * - * The array order is oldest week (index 0) to most recent week. - * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. - */ "repos/get-participation-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The array order is oldest week (index 0) to most recent week. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["participation-stats"]; }; @@ -97461,26 +105999,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the hourly commit count for each day - * @description Each array contains the day number, hour number, and number of commits: - * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits - * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - */ "repos/get-punch-card-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -97488,19 +106025,18 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Create a commit status - * @description Users with push access in a repository can create commit statuses for a given SHA. - * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - */ "repos/create-commit-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; sha: string; }; + cookie?: never; }; requestBody: { content: { @@ -97510,11 +106046,9 @@ export interface operations { * @enum {string} */ state: "error" | "failure" | "pending" | "success"; - /** - * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. - * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: - * `http://ci.example.com/user/repo/build/sha` - */ + /** @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; /** @description A short description of the status. */ description?: string | null; @@ -97532,6 +106066,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"]; @@ -97539,26 +106074,30 @@ export interface operations { }; }; }; - /** - * List watchers - * @description Lists the people watching the specified repository. - */ "activity/list-watchers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -97566,20 +106105,25 @@ export interface operations { }; }; }; - /** - * Get a repository subscription - * @description Gets information about whether the authenticated user is subscribed to the repository. - */ "activity/get-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if you subscribe to the repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; @@ -97587,20 +106131,24 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#delete-a-repository-subscription) completely. - */ "activity/set-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97615,47 +106163,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - /** - * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#set-a-repository-subscription). - */ "activity/delete-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List repository tags */ "repos/list-tags": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["tag"][]; @@ -97663,22 +106226,25 @@ export interface operations { }; }; }; - /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ "repos/list-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"][]; }; @@ -97687,17 +106253,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/create-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97710,6 +106276,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"]; }; @@ -97718,78 +106287,83 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/delete-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the tag protection. */ tag_protection_id: components["parameters"]["tag-protection-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Download a repository archive (tar) - * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. - */ "repos/download-tarball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * List repository teams - * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. - * - * For a public repository, a team is listed only if that team added the public repository explicitly. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. - */ "repos/list-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -97798,21 +106372,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get all repository topics */ "repos/get-all-topics": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -97820,13 +106403,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Replace all repository topics */ "repos/replace-all-topics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97839,6 +106426,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -97847,17 +106437,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/enterprise-server@3.9/articles/about-repository-transfers/). - * You must use a personal access token or an OAuth token for this endpoint. An installation access token cannot be used because it is only granted access to a single account. - */ "repos/transfer": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97874,113 +106464,128 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - /** - * Check if vulnerability alerts are enabled for a repository - * @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/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/check-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if repository is enabled with vulnerability alerts */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not enabled with vulnerability alerts */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable vulnerability alerts - * @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/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/enable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable vulnerability alerts - * @description Disables dependency alerts 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/enterprise-server@3.9/articles/about-security-alerts-for-vulnerable-dependencies)". - */ "repos/disable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download a repository archive (zip) - * @description 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 - * 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. - */ "repos/download-zipball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-using-template": { parameters: { + query?: never; + header?: never; path: { /** @description The account owner of the template repository. The name is not case sensitive. */ template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ template_repo: string; }; + cookie?: never; }; requestBody: { content: { @@ -98010,6 +106615,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -98017,28 +106623,26 @@ export interface operations { }; }; }; - /** - * List public repositories - * @description Lists all public repositories in the order that they were created. - * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. - */ "repos/list-public": { parameters: { query?: { + /** @description A repository ID. Only return repositories with an ID greater than this ID. */ since?: components["parameters"]["since-repo"]; /** @description Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise. */ visibility?: "all" | "public"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -98048,30 +106652,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List provisioned SCIM groups for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Lists provisioned SCIM groups in an enterprise. - * - * You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. - */ "enterprise-admin/list-provisioned-groups-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either groups were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-list"]; }; @@ -98083,19 +106689,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Creates a SCIM group for an enterprise. - * - * If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. - */ "enterprise-admin/provision-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -98105,6 +106707,9 @@ export interface operations { responses: { /** @description Group has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -98117,25 +106722,28 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Gets information about a SCIM group. - */ "enterprise-admin/get-provisioning-information-for-enterprise-group": { parameters: { query?: { + /** @description Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. */ excludedAttributes?: components["parameters"]["excluded-attributes"]; }; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a group was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -98148,20 +106756,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Replaces an existing provisioned group’s information. - * - * You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. - */ "enterprise-admin/set-information-for-provisioned-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -98171,6 +106776,9 @@ export interface operations { responses: { /** @description Group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; @@ -98184,23 +106792,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM group from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Deletes a SCIM group from an enterprise. - */ "enterprise-admin/delete-scim-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Group was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -98210,22 +106821,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise group - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Update a provisioned group’s individual attributes. - * - * To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. - * - * Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. - */ "enterprise-admin/update-attribute-for-enterprise-group": { parameters: { + query?: never; + header?: never; path: { + /** @description A unique identifier of the SCIM group. */ scim_group_id: components["parameters"]["scim-group-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -98235,13 +106841,19 @@ export interface operations { responses: { /** @description Success, group was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-group-response"]; }; }; /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -98252,29 +106864,30 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * List SCIM provisioned identities for an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Lists provisioned SCIM enterprise members. - * - * When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. - */ "enterprise-admin/list-provisioned-identities-enterprise": { parameters: { query?: { /** @description If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. */ filter?: string; + /** @description Used for pagination: the starting index of the first result to return when paginating through values. */ startIndex?: components["parameters"]["start-index"]; + /** @description Used for pagination: the number of results to return per page. */ count?: components["parameters"]["count"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, either users were found or not found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-list"]; }; @@ -98286,21 +106899,15 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Provision a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Creates an external identity for a new SCIM enterprise user. - * - * SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. - * - * When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. - */ "enterprise-admin/provision-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -98310,6 +106917,9 @@ export interface operations { responses: { /** @description User has been created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -98322,22 +106932,25 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Get SCIM provisioning information for an enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Gets information about a SCIM user. - */ "enterprise-admin/get-provisioning-information-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Success, a user was found */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -98350,22 +106963,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Set SCIM information for a provisioned enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Replaces an existing provisioned user's information. - * - * You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - */ "enterprise-admin/set-information-for-provisioned-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -98375,6 +106983,9 @@ export interface operations { responses: { /** @description User was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -98388,23 +106999,26 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Delete a SCIM user from an enterprise - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. - */ "enterprise-admin/delete-user-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description User was deleted, no content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["scim_bad_request"]; 401: components["responses"]["authorization_failure"]; @@ -98414,34 +107028,17 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Update an attribute for a SCIM enterprise user - * @description **Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change. - * - * Update a provisioned user's individual attributes. - * - * To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). - * - * **Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. - * - * **Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. - * ``` - * { - * "Operations":[{ - * "op":"replace", - * "value":{ - * "active":false - * } - * }] - * } - * ``` - */ "enterprise-admin/update-attribute-for-enterprise-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SCIM user. */ scim_user_id: components["parameters"]["scim-user-id"]; + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -98451,6 +107048,9 @@ export interface operations { responses: { /** @description Success, user was updated */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/scim+json": components["schemas"]["scim-enterprise-user-response"]; }; @@ -98464,27 +107064,6 @@ export interface operations { 500: components["responses"]["scim_internal_error"]; }; }; - /** - * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). - * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: - * - * `q=addClass+in:file+language:js+repo:jquery/jquery` - * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. - * - * Considerations for code search: - * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: - * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - */ "search/code": { parameters: { query: { @@ -98494,13 +107073,22 @@ export interface operations { sort?: "indexed"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -98515,17 +107103,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). - * - * 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/enterprise-server@3.9/rest/search/search#text-match-metadata). - * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - * - * `q=repo:octocat/Spoon-Knife+css` - */ "search/commits": { parameters: { query: { @@ -98533,14 +107110,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -98552,21 +107139,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). - * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.9/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." - */ "search/issues-and-pull-requests": { parameters: { query: { @@ -98585,14 +107157,24 @@ export interface operations { | "interactions" | "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -98607,18 +107189,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). - * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - * - * `q=bug+defect+enhancement&repository_id=64778136` - * - * The labels that best match the query appear first in the search results. - */ "search/labels": { parameters: { query: { @@ -98628,14 +107198,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -98650,18 +107230,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). - * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: - * - * `q=tetris+language:assembly&sort=stars&order=desc` - * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - */ "search/repos": { parameters: { query: { @@ -98669,14 +107237,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -98690,30 +107268,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.9/articles/searching-topics/)" for a detailed list of qualifiers. - * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). - * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: - * - * `q=ruby+is:featured` - * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - */ "search/topics": { parameters: { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.9/rest/search/search#constructing-a-search-query). */ q: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -98725,20 +107300,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.9/rest/search/search#text-match-metadata). - * - * For example, if you're looking for a list of popular users, you might try this query: - * - * `q=tom+repos:%3E42+followers:%3E1000` - * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/enterprise-server@3.9/graphql/reference/queries#search)." - */ "search/users": { parameters: { query: { @@ -98746,14 +107307,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.9/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -98767,84 +107338,100 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get the configuration status - * @description This endpoint allows you to check the status of the most recent configuration process: - * - * Note that you may need to wait several seconds after you start a process before you can check its status. - * - * The different statuses are: - * - * | Status | Description | - * | ------------- | --------------------------------- | - * | `PENDING` | The job has not started yet | - * | `CONFIGURING` | The job is running | - * | `DONE` | The job has finished correctly | - * | `FAILED` | The job has finished unexpectedly | - */ "enterprise-admin/get-configuration-status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["configuration-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Start a configuration process - * @description This endpoint allows you to start a configuration process at any time for your updated settings to take effect: - */ "enterprise-admin/start-configuration-process": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the maintenance status - * @description Check your installation's maintenance status: - */ "enterprise-admin/get-maintenance-status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["maintenance-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable or disable maintenance mode - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/enable-or-disable-maintenance-mode": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { - /** - * @description A JSON string with the attributes `enabled` and `when`. + /** @description A JSON string with the attributes `enabled` and `when`. * - * The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. + * The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. * - * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). - */ + * The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). */ maintenance: string; }; }; @@ -98852,46 +107439,56 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["maintenance-status"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get settings - * @description Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#set-settings). - * - * **Note:** You cannot retrieve the management console password with the Enterprise administration API. - */ "enterprise-admin/get-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-settings"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set settings - * @description Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#get-settings). - * - * **Notes:** - * - * - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - * - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.9/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." - */ "enterprise-admin/set-settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -98903,34 +107500,54 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Get all authorized SSH keys */ "enterprise-admin/get-all-authorized-ssh-keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/add-authorized-ssh-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -98942,21 +107559,29 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an authorized SSH key - * @description **Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). - */ "enterprise-admin/remove-authorized-ssh-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/x-www-form-urlencoded": { @@ -98968,30 +107593,29 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-key"][]; }; }; /** @description Unauthorized */ 401: { - content: never; - }; - }; - }; - /** - * Create a GitHub license - * @description When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. - * - * Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. - * - * When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: - * - * 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. - * 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "enterprise-admin/create-enterprise-server-license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "multipart/form-data": { @@ -99007,21 +107631,27 @@ export interface operations { responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Upgrade a license - * @description This API upgrades your license and also triggers the configuration process. - * - * **Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). - */ "enterprise-admin/upgrade-license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "multipart/form-data": { @@ -99033,28 +107663,37 @@ export interface operations { responses: { /** @description Response */ 202: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#get-a-team-by-name) endpoint. - */ "teams/get-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -99062,44 +107701,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#delete-a-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - */ "teams/delete-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - */ "teams/update-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -99110,11 +107743,11 @@ export interface operations { description?: string; /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; @@ -99132,12 +107765,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -99147,31 +107786,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -99179,22 +107817,15 @@ export interface operations { }; }; }; - /** - * Create a discussion (Legacy) - * @deprecated - * @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/enterprise-server@3.9/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -99214,75 +107845,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99297,38 +107927,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -99336,23 +107969,17 @@ export interface operations { }; }; }; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @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/enterprise-server@3.9/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -99365,78 +107992,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -99449,21 +108078,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { @@ -99477,20 +108100,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -99498,24 +108130,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -99539,21 +108166,15 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { @@ -99567,19 +108188,27 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -99587,23 +108216,17 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.9/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -99627,36 +108250,39 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List team members (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/enterprise-server@3.9/rest/teams/members#list-team-members) endpoint. - * - * Team members will include the members of child teams. - */ "teams/list-members-legacy": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -99665,126 +108291,123 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get team member (Legacy) - * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/get-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if user is not a member */ 404: { - content: never; - }; - }; - }; - /** - * Add team member (Legacy) - * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ 422: { - content: never; - }; - }; - }; - /** - * Remove team member (Legacy) - * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/remove-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team synchronization is setup */ 404: { - content: never; - }; - }; - }; - /** - * Get team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#get-team-membership-for-a-user) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#create-a-team). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/get-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; @@ -99792,27 +108415,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add or update team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - * - * **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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If 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. - */ "teams/add-or-update-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99829,72 +108442,82 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#remove-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.9/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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ "teams/remove-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ "teams/list-projects-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -99903,46 +108526,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - */ "teams/check-permissions-for-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - */ "teams/add-or-update-project-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99958,10 +108584,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -99973,49 +108605,53 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - */ "teams/remove-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List team repositories (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-team-repositories) endpoint. - */ "teams/list-repos-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -100024,56 +108660,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a repository (Legacy) - * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types/) via the `Accept` header: - */ "teams/check-permissions-for-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with extra repository information */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions (Legacy) - * @deprecated - * @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/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. - * - * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "teams/add-or-update-repo-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -100089,54 +108729,62 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#remove-a-repository-from-a-team) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - */ "teams/remove-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-child-teams) endpoint. - */ "teams/list-child-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -100147,14 +108795,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. - */ "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -100166,11 +108820,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Update the authenticated user - * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. - */ "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -100214,6 +108870,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["private-user"]; }; @@ -100225,41 +108884,45 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get list of conflicting packages during Docker migration for authenticated-user - * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; }; }; }; - /** - * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible - * to the public. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -100271,11 +108934,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -100290,6 +108955,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["email"][]; }; @@ -100301,11 +108969,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -100317,7 +108987,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -100326,22 +108999,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List followers of the authenticated user - * @description Lists the people following the authenticated user. - */ "users/list-followers-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -100352,22 +109028,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List the people the authenticated user follows - * @description Lists the people who the authenticated user follows. - */ "users/list-followed-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -100378,45 +109057,57 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Check if a person is followed by the authenticated user */ "users/check-person-is-followed-by-authenticated": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the person is followed by the authenticated user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/follow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -100424,20 +109115,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unfollow a user - * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/unfollow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -100445,24 +109140,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -100474,13 +109170,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -100494,6 +109190,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -100505,21 +109204,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/get-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -100530,22 +109231,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. - */ "users/delete-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -100554,26 +109257,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List app installations accessible to the user access token - * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You can find the permissions for the installation under the `permissions` key. - */ "apps/list-installations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -100587,29 +109289,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories accessible to the user access token - * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * The access the user has to each repository is included in the hash under the `permissions` key. - */ "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -100624,66 +109325,58 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add a repository to an app installation - * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.9/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List user account issues assigned to the authenticated user - * @description 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 - * 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/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-authenticated-user": { parameters: { query?: { @@ -100697,20 +109390,30 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -100720,24 +109423,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key"][]; @@ -100749,13 +109453,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -100772,6 +109476,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -100783,21 +109490,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/get-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -100808,22 +109517,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. - */ "users/delete-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -100831,24 +109542,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization memberships for the authenticated user - * @description Lists all of the authenticated user's organization memberships. - */ "orgs/list-memberships-for-authenticated-user": { parameters: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-membership"][]; @@ -100860,19 +109574,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization membership for the authenticated user - * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. - */ "orgs/get-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -100881,15 +109599,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization membership for the authenticated user - * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. - */ "orgs/update-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -100905,6 +109623,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -100914,22 +109635,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List user migrations - * @description Lists all migrations a user has started. - */ "migrations/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -100940,11 +109664,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Start a user migration - * @description Initiates the generation of a user migration archive. - */ "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -100987,8 +109713,8 @@ export interface operations { /** * @description Exclude attributes from the API response to improve performance * @example [ - * "repositories" - * ] + * "repositories" + * ] */ exclude?: "repositories"[]; repositories: string[]; @@ -100998,6 +109724,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -101008,65 +109737,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Download a user migration archive - * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - */ "migrations/get-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories for a user migration - * @description Lists all the repositories for this user migration. - */ "migrations/list-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -101075,24 +109791,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organizations for the authenticated user - * @description List organizations for the authenticated user. - * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. - */ "orgs/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -101103,12 +109820,6 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List packages for the authenticated user's namespace - * @description Lists packages owned by the authenticated user within the user's namespace. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-authenticated-user": { parameters: { query: { @@ -101120,14 +109831,27 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -101135,104 +109859,112 @@ export interface operations { 400: components["responses"]["package_es_list_error"]; }; }; - /** - * Get a package for the authenticated user - * @description Gets a specific package for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for the authenticated user - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for the authenticated user - * @description Restores a package owned by the authenticated user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-authenticated-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by the authenticated user - * @description Lists package versions for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -101242,88 +109974,96 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for the authenticated user - * @description Gets a specific package version for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete a package version for the authenticated user - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package version for the authenticated user - * @description Restores a package version owned by the authenticated user. - * - * You can restore a deleted package version under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -101343,6 +110083,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -101353,26 +110096,25 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-public-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -101384,23 +110126,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories for the authenticated user - * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - */ "repos/list-for-authenticated-user": { parameters: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "public" | "private"; - /** - * @description Comma-separated list of values. Can include: - * * `owner`: Repositories that are owned by the authenticated user. - * * `collaborator`: Repositories that the user has been added to as a collaborator. - * * `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: + * * `owner`: Repositories that are owned by the authenticated user. + * * `collaborator`: Repositories that the user has been added to as a collaborator. + * * `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. */ affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ type?: "all" | "owner" | "public" | "private" | "member"; @@ -101408,15 +110142,26 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; + /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before-repo-date"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository"][]; }; @@ -101427,13 +110172,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a repository for the authenticated user - * @description Creates a new repository for the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -101525,34 +110270,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -101577,6 +110322,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -101590,22 +110336,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository invitations for the authenticated user - * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. - */ "repos/list-invitations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -101617,17 +110366,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Decline a repository invitation */ "repos/decline-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -101635,17 +110391,24 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** Accept a repository invitation */ "repos/accept-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -101653,22 +110416,25 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List social accounts for the authenticated user - * @description Lists all of your social accounts. - */ "users/list-social-accounts-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -101680,13 +110446,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -101701,6 +110467,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["social-account"][]; }; @@ -101712,13 +110481,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -101733,7 +110502,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101742,24 +110514,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/list-ssh-signing-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -101771,13 +110544,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. - */ "users/create-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -101794,6 +110567,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -101805,21 +110581,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/get-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -101830,22 +110608,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. - */ "users/delete-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101853,28 +110633,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories starred by the authenticated user - * @description Lists repositories the authenticated user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-authenticated-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository"][]; @@ -101886,48 +110667,61 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Check if a repository is starred by the authenticated user - * @description Whether the authenticated user has starred the repository. - */ "activity/check-repo-is-starred-by-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if this repository is starred by you */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description Not Found if this repository is not starred by you */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "activity/star-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101935,21 +110729,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unstar a repository for the authenticated user - * @description Unstar a repository that the authenticated user has previously starred. - */ "activity/unstar-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -101957,22 +110756,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories watched by the authenticated user - * @description Lists repositories the authenticated user is watching. - */ "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -101983,27 +110785,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. - * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. - * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. - */ "teams/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-full"][]; @@ -102014,25 +110814,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List users - * @description Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.9/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. - */ "users/list": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -102041,23 +110842,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a user - * @description Provides publicly available information about someone with a GitHub account. - * - * The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#authentication). - * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/enterprise-server@3.9/rest/users/emails)". - */ "users/get-by-username": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -102067,21 +110868,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get list of conflicting packages during Docker migration for user - * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -102090,92 +110893,114 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - */ "activity/list-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List organization events for the authenticated user - * @description This is the user's organization dashboard. You must be authenticated as the user to view this. - */ "activity/list-org-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events for a user */ "activity/list-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List followers of a user - * @description Lists the people following the specified user. - */ "users/list-followers-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -102183,25 +111008,28 @@ export interface operations { }; }; }; - /** - * List the people a user follows - * @description Lists the people who the specified user follows. - */ "users/list-following-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -102209,45 +111037,59 @@ export interface operations { }; }; }; - /** Check if a user follows another user */ "users/check-following-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; target_user: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the user follows the target user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if the user does not follow the target user */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List gists for a user - * @description Lists public gists for the specified user: - */ "gists/list-for-user": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -102256,25 +111098,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List GPG keys for a user - * @description Lists the GPG keys for a user. This information is accessible by anyone. - */ "users/list-gpg-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -102282,14 +111127,6 @@ export interface operations { }; }; }; - /** - * Get contextual information for a user - * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "users/get-context-for-user": { parameters: { query?: { @@ -102298,13 +111135,20 @@ export interface operations { /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ subject_id?: string; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hovercard"]; }; @@ -102313,46 +111157,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user installation for the authenticated app - * @description Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-user-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List public keys for a user - * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - */ "users/list-public-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key-simple"][]; @@ -102360,27 +111209,28 @@ export interface operations { }; }; }; - /** - * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/enterprise-server@3.9/articles/publicizing-or-concealing-organization-membership) for the specified user. - * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. - */ "orgs/list-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -102388,12 +111238,6 @@ export interface operations { }; }; }; - /** - * List packages for a user - * @description Lists all packages in a user's namespace for which the requesting user has access. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/list-packages-for-user": { parameters: { query: { @@ -102405,17 +111249,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -102425,106 +111282,113 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for a user - * @description Gets a specific package metadata for a public package owned by a user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for a user - * @description Restores an entire package for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-for-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by a user - * @description Lists package versions for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -102534,109 +111398,119 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for a user - * @description Gets a specific package version for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/get-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/delete-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for a user - * @description Restores a specific package version for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - */ "packages/restore-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List user projects - * @description Lists projects for a user. - */ "projects/list-for-user": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -102645,53 +111519,62 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. - */ "activity/list-received-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events received by a user */ "activity/list-received-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List repositories for a user - * @description Lists public repositories for the specified user. - */ "repos/list-for-user": { parameters: { query?: { @@ -102701,18 +111584,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -102720,59 +111610,70 @@ export interface operations { }; }; }; - /** - * Promote a user to be a site administrator - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "enterprise-admin/promote-user-to-be-site-administrator": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Demote a site administrator - * @description You can demote any user account except your own. - */ "enterprise-admin/demote-site-administrator": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List social accounts for a user - * @description Lists social media accounts for a user. This endpoint is accessible by anyone. - */ "users/list-social-accounts-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -102780,25 +111681,28 @@ export interface operations { }; }; }; - /** - * List SSH signing keys for a user - * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. - */ "users/list-ssh-signing-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -102806,31 +111710,32 @@ export interface operations { }; }; }; - /** - * List repositories starred by a user - * @description Lists repositories a user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -102840,25 +111745,28 @@ export interface operations { }; }; }; - /** - * List repositories watched by a user - * @description Lists repositories a user is watching. - */ "activity/list-repos-watched-by-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -102866,19 +111774,15 @@ export interface operations { }; }; }; - /** - * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. - * - * You can suspend any user account except your own. - * - * 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 method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "enterprise-admin/suspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102891,19 +111795,22 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. - */ "enterprise-admin/unsuspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102916,83 +111823,59 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the Zen of GitHub - * @description Get a random sentence from the Zen of GitHub - */ "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string; }; }; }; }; - /** - * Compare two commits - * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. - * - * 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. - * - * 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, 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)." - * - * 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 following fields are included in the `verification` object: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; base: string; head: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index 7ea860fa8..d294b031a 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -3,266 +3,617 @@ * Do not make direct changes to the file. */ -/** OneOf type helpers */ -type Without = { [P in Exclude]?: never }; -type XOR = T | U extends object - ? (Without & U) | (Without & T) - : T | U; -type OneOf = T extends [infer Only] - ? Only - : T extends [infer A, infer B, ...infer Rest] - ? OneOf<[XOR, ...Rest]> - : never; - export interface paths { "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List global webhooks */ get: operations["enterprise-admin/list-global-webhooks"]; + put?: never; /** Create a global webhook */ post: operations["enterprise-admin/create-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a global webhook */ get: operations["enterprise-admin/get-global-webhook"]; + put?: never; + post?: never; /** Delete a global webhook */ delete: operations["enterprise-admin/delete-global-webhook"]; + options?: never; + head?: never; /** * Update a global webhook * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. */ patch: operations["enterprise-admin/update-global-webhook"]; + trace?: never; }; "/admin/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a global webhook * @description This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the webhook. */ post: operations["enterprise-admin/ping-global-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public keys */ get: operations["enterprise-admin/list-public-keys"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/keys/{key_ids}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a public key */ delete: operations["enterprise-admin/delete-public-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an organization */ post: operations["enterprise-admin/create-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** Update an organization name */ patch: operations["enterprise-admin/update-org-name"]; + trace?: never; }; "/admin/pre-receive-environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List pre-receive environments */ get: operations["enterprise-admin/list-pre-receive-environments"]; + put?: never; /** Create a pre-receive environment */ post: operations["enterprise-admin/create-pre-receive-environment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a pre-receive environment */ get: operations["enterprise-admin/get-pre-receive-environment"]; + put?: never; + post?: never; /** * Delete a pre-receive environment * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Cannot delete environment that has hooks_ + * * _Cannot delete environment when download is in progress_ */ delete: operations["enterprise-admin/delete-pre-receive-environment"]; + options?: never; + head?: never; /** * Update a pre-receive environment * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. */ patch: operations["enterprise-admin/update-pre-receive-environment"]; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a pre-receive environment download * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. + * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. * - * The possible error messages are: + * The possible error messages are: * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ + * * _Cannot modify or delete the default environment_ + * * _Can not start a new download when a download is in progress_ */ post: operations["enterprise-admin/start-pre-receive-environment-download"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the download status for a pre-receive environment * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. */ get: operations["enterprise-admin/get-download-status-for-pre-receive-environment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List personal access tokens * @description Lists personal access tokens for all users, including admin users. */ get: operations["enterprise-admin/list-personal-access-tokens"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/tokens/{token_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a personal access token * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. */ delete: operations["enterprise-admin/delete-personal-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a user * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/github-ae@latest/rest/enterprise-admin/users#suspend-a-user) is often a better option. * - * You can delete any user account except your own. + * You can delete any user account except your own. */ delete: operations["enterprise-admin/delete-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/admin/users/{username}/authorizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create an impersonation OAuth token */ post: operations["enterprise-admin/create-impersonation-o-auth-token"]; /** Delete an impersonation OAuth token */ delete: operations["enterprise-admin/delete-impersonation-o-auth-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated app * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/github-ae@latest/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/github-ae@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installations for the authenticated app * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * - * The permissions the installation has are included under the `permissions` key. + * The permissions the installation has are included under the `permissions` key. */ get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/github-ae@latest/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub AE API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. @@ -273,460 +624,996 @@ export interface paths { * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. */ delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; + trace?: never; }; "/applications/{client_id}/tokens/{access_token}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Reset an authorization * @deprecated * @description **Deprecation Notice:** GitHub AE will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). * - * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. + * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ post: operations["apps/reset-authorization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) of the target app to access this endpoint. + * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) of the target app to access this endpoint. */ get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get emojis * @description Lists all the emojis available to use on GitHub AE. */ get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the global announcement banner * @description Gets the current message and expiration date of the global announcement banner in your enterprise. */ get: operations["enterprise-admin/get-announcement"]; + put?: never; + post?: never; /** * Remove the global announcement banner * @description Removes the global announcement banner in your enterprise. */ delete: operations["enterprise-admin/remove-announcement"]; + options?: never; + head?: never; /** * Set the global announcement banner * @description Sets the message and expiration time for the global announcement banner in your enterprise. */ patch: operations["enterprise-admin/set-announcement"]; + trace?: never; }; "/enterprise/settings/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get license information */ get: operations["enterprise-admin/get-license-information"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/all": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all statistics */ get: operations["enterprise-admin/get-all-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get comment statistics */ get: operations["enterprise-admin/get-comment-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get gist statistics */ get: operations["enterprise-admin/get-gist-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get hooks statistics */ get: operations["enterprise-admin/get-hooks-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get issue statistics */ get: operations["enterprise-admin/get-issue-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get milestone statistics */ get: operations["enterprise-admin/get-milestone-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get organization statistics */ get: operations["enterprise-admin/get-org-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pages statistics */ get: operations["enterprise-admin/get-pages-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get pull request statistics */ get: operations["enterprise-admin/get-pull-request-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get repository statistics */ get: operations["enterprise-admin/get-repo-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprise/stats/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get users statistics */ get: operations["enterprise-admin/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an enterprise * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-github-actions-permissions-enterprise"]; /** * Set GitHub Actions permissions for an enterprise * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-github-actions-permissions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise"]; /** * Set selected organizations enabled for GitHub Actions in an enterprise * @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)." * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected organization for GitHub Actions in an enterprise * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/enable-selected-organization-github-actions-enterprise"]; + post?: never; /** * Disable a selected organization for GitHub Actions in an enterprise * @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)." * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/disable-selected-organization-github-actions-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an enterprise * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-allowed-actions-enterprise"]; /** * Set allowed actions for an enterprise * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-allowed-actions-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an enterprise * @description Lists all self-hosted runner groups for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runner-groups-for-enterprise"]; + put?: never; /** * Create a self-hosted runner group for an enterprise * @description Creates a new self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ post: operations["enterprise-admin/create-self-hosted-runner-group-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an enterprise * @description Gets a specific self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-group-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an enterprise * @description Deletes a self-hosted runner group for an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-group-from-enterprise"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an enterprise * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ patch: operations["enterprise-admin/update-self-hosted-runner-group-for-enterprise"]; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners in a group for an enterprise * @description Lists the self-hosted runners that are in a specific enterprise group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-in-group-for-enterprise"]; /** * Set self-hosted runners in a group for an enterprise * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ put: operations["enterprise-admin/set-self-hosted-runners-in-group-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an enterprise * @description Adds a self-hosted runner to a runner group configured in an enterprise. * - * You must authenticate using an access token with the `manage_runners:enterprise` - * scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` + * scope to use this endpoint. */ put: operations["enterprise-admin/add-self-hosted-runner-to-group-for-enterprise"]; + post?: never; /** * Remove a self-hosted runner from a group for an enterprise * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an enterprise * @description Lists all self-hosted runners configured for an enterprise. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-self-hosted-runners-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an enterprise * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/list-runner-applications-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an enterprise * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * - * Example using registration token: + * Example using registration token: * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN + * ``` */ post: operations["enterprise-admin/create-registration-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an enterprise * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. * - * Example using remove token: + * Example using remove token: * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. + * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + * endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` */ post: operations["enterprise-admin/create-remove-token-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an enterprise * @description Gets a specific self-hosted runner configured in an enterprise. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ get: operations["enterprise-admin/get-self-hosted-runner-for-enterprise"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an enterprise * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. + * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. */ delete: operations["enterprise-admin/delete-self-hosted-runner-from-enterprise"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an enterprise * @description Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. */ get: operations["enterprise-admin/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an enterprise * @description 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/github-ae@latest/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. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). */ get: operations["secret-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get feeds * @description GitHub AE provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: * - * * **Timeline**: The GitHub AE global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub AE. + * * **Timeline**: The GitHub AE global public timeline + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub AE. * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List starred gists * @description List the authenticated user's starred gists: */ get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @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. */ patch: operations["gists/update"]; + trace?: never; }; "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update-comment"]; + trace?: never; }; "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist commits */ get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist forks */ get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a gist is starred */ get: operations["gists/check-is-starred"]; /** @@ -734,119 +1621,273 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; + post?: never; /** Unstar a gist */ delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/github-ae@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. * - * You must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + * You must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/github-ae@latest/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/github-ae@latest/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. * - * You must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + * You must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issues assigned to the authenticated user * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Render a Markdown document */ post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub AE meta information * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/github-ae@latest/articles/about-github-s-ip-addresses/)." * - * The API's response also includes a list of GitHub's domain names. + * The API's response also includes a list of GitHub's domain names. * - * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. + * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. @@ -857,578 +1898,1074 @@ export interface paths { * @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 AE 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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + put?: never; + post?: never; /** * Mark a thread as done * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub AE as done: https://github.com/notifications. */ delete: operations["activity/mark-thread-as-done"]; + options?: never; + head?: never; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub AE: https://github.com/notifications. */ patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread subscription for the authenticated user * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/github-ae@latest/rest/activity/watching#get-a-repository-subscription). * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/github-ae@latest/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/github-ae@latest/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/github-ae@latest/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Octocat * @description Get the octocat as ASCII art */ get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations * @description Lists all organizations, in the order that they were created on GitHub AE. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/github-ae@latest/articles/securing-your-account-with-two-factor-authentication-2fa/). * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See "[Authenticating with GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub AE plan information' below." + * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See "[Authenticating with GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub AE plan information' below." */ get: operations["orgs/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization * @description **Parameter Deprecation Notice:** GitHub AE 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). * - * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. */ patch: operations["orgs/update"]; + trace?: never; }; "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. + * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories enabled for GitHub Actions in an organization * @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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** * Set selected repositories enabled for GitHub Actions in an organization * @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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for an organization * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions for an organization * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. * - * To 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. + * To 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. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/github-ae@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/github-ae@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/github-ae@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." + * can submit approving pull request reviews. For more information, see + * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/github-ae@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runner groups for an organization * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runner-groups-for-org"]; + put?: never; /** * Create a self-hosted runner group for an organization * @description Creates a new self-hosted runner group for an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner group for an organization * @description Gets a specific self-hosted runner group for an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-group-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner group from an organization * @description Deletes a self-hosted runner group for an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-group-from-org"]; + options?: never; + head?: never; /** * Update a self-hosted runner group for an organization * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. */ patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; }; "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a self-hosted runner to a group for an organization * @description Adds a self-hosted runner to a runner group configured in an organization. * - * You must authenticate using an access token with the `admin:org` - * scope to use this endpoint. + * You must authenticate using an access token with the `admin:org` + * scope to use this endpoint. */ put: operations["actions/add-self-hosted-runner-to-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * Example using registration token: + * Example using registration token: * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` */ post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * Example using remove token: + * Example using remove token: * - * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - * endpoint. + * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this + * endpoint. * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` */ post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/github-ae@latest/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/github-ae@latest/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @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. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * If the repository is private, you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` organization permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/audit-log": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the audit log for an organization * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." * - * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. + * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github-ae@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github-ae@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api)." + * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api)." */ get: operations["orgs/get-audit-log"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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. + * 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. + * For public repositories, you may instead use the `public_repo` scope. */ get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-group/{group_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an external group * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/external-idp-group-info-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List external groups in an organization * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub AE generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ get: operations["teams/list-external-idp-groups-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List organization webhooks */ get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description Here's how you can create a hook that posts payloads in JSON format: */ post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization webhook * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." */ get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** Delete an organization webhook */ delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." */ patch: operations["orgs/update-webhook"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. */ get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. */ patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. */ get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. */ get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. */ post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping an organization webhook * @description This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. */ post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations for an organization * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. @@ -1438,1057 +2975,2064 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/github-ae@latest/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/github-ae@latest/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * - * **Rate limits** + * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization migrations * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). * - * A list of `repositories` is only returned for export migrations. + * A list of `repositories` is only returned for export migrations. */ get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. */ post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization migration status * @description Fetches the status of a migration. * - * The `state` of a migration can be one of the following values: + * The `state` of a migration can be one of the following values: * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/github-ae@latest/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Convert an organization member to outside collaborator * @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/github-ae@latest/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/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-org"]; + put?: never; /** * Create an organization project * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization repositories * @description 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/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * **OAuth scope requirements** + * **OAuth scope requirements** * - * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository */ post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ get: operations["teams/list"]; + put?: never; /** * Create a team * @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/github-ae@latest/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-ae@latest/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/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub AE replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. */ get: operations["teams/list-discussions-in-org"]; + put?: never; /** * Create a discussion * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. */ post: operations["teams/create-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ get: operations["teams/get-discussion-in-org"]; + put?: never; + post?: never; /** * Delete a discussion * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ delete: operations["teams/delete-discussion-in-org"]; + options?: never; + head?: never; /** * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. */ patch: operations["teams/update-discussion-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. */ get: operations["teams/list-discussion-comments-in-org"]; + put?: never; /** * Create a discussion comment * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * **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`. + * **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`. */ post: operations["teams/create-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ get: operations["teams/get-discussion-comment-in-org"]; + put?: never; + post?: never; /** * Delete a discussion comment * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ delete: operations["teams/delete-discussion-comment-in-org"]; + options?: never; + head?: never; /** * Update a discussion comment * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. */ patch: operations["teams/update-discussion-comment-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; + put?: never; /** * Create reaction for a team discussion comment * @description Create a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["reactions/delete-for-team-discussion-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ get: operations["reactions/list-for-team-discussion-in-org"]; + put?: never; /** * Create reaction for a team discussion * @description Create a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. */ post: operations["reactions/create-for-team-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["reactions/delete-for-team-discussion"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/external-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove the connection between an external group and a team * @description Deletes a connection between a team and an external group. * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["teams/unlink-external-idp-group-from-team-for-org"]; + options?: never; + head?: never; /** * Update the connection between an external group and a team * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. */ patch: operations["teams/link-external-idp-group-to-team-for-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members * @description Team members will include the members of child teams. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user * @description Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 AE 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 AE](https://docs.github.com/github-ae@latest/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. + * 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. * - * If 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. + * If 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. * - * **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}`. + * **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}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @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. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 AE 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 AE](https://docs.github.com/github-ae@latest/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}`. + * **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}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; + post?: never; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **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}`. + * **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-ae@latest/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/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/cards/{card_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project card * @description Gets information about a project card. */ get: operations["projects/get-card"]; + put?: never; + post?: never; /** * Delete a project card * @description Deletes a project card */ delete: operations["projects/delete-card"]; + options?: never; + head?: never; /** Update an existing project card */ patch: operations["projects/update-card"]; + trace?: never; }; "/projects/columns/cards/{card_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project card */ post: operations["projects/move-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project column * @description Gets information about a project column. */ get: operations["projects/get-column"]; + put?: never; + post?: never; /** * Delete a project column * @description Deletes a project column. */ delete: operations["projects/delete-column"]; + options?: never; + head?: never; /** Update an existing project column */ patch: operations["projects/update-column"]; + trace?: never; }; "/projects/columns/{column_id}/cards": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project cards * @description Lists the project cards in a project. */ get: operations["projects/list-cards"]; + put?: never; /** Create a project card */ post: operations["projects/create-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project column */ post: operations["projects/move-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/get"]; + put?: never; + post?: never; /** * Delete a project * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ delete: operations["projects/delete"]; + options?: never; + head?: never; /** * Update a project * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ patch: operations["projects/update"]; + trace?: never; }; "/projects/{project_id}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project collaborators * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ get: operations["projects/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add project collaborator * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ put: operations["projects/add-collaborator"]; + post?: never; /** * Remove user as a collaborator * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ delete: operations["projects/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get project permission for a user * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ get: operations["projects/get-permission-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/columns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project columns * @description Lists the project columns in a project. */ get: operations["projects/list-columns"]; + put?: never; /** * Create a project column * @description Creates a new project column. */ post: operations["projects/create-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/github-ae@latest/rest/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/github-ae@latest/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/github-ae@latest/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/github-ae@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/github-ae@latest/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/github-ae@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/github-ae@latest/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/github-ae@latest/rest/overview/api-versions)." + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/github-ae@latest/rest/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/github-ae@latest/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/github-ae@latest/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/github-ae@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/github-ae@latest/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/github-ae@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/github-ae@latest/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/github-ae@latest/rest/overview/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository * @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. * - * **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/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ get: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. */ delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/github-ae@latest/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List artifacts for 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. */ get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an artifact * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. */ delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an artifact * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a job for a workflow run * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. 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 `Location:` in the response header to find the URL for the download. 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. */ get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization secrets * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. + * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. * - * You 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. + * You 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. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. + * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. * - * You 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. + * You 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. */ put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions for a repository * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You 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. + * You 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. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions for a repository * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. * - * To 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. + * To 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. * - * You 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. + * You 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. */ put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for a repository * @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. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token - * expires after one hour. + * expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * Example using registration token: + * Example using registration token: * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - * by this endpoint. + * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided + * by this endpoint. * - * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` */ post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to remove a self-hosted runner from - * a repository. The token expires after one hour. + * a repository. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * - * Example using remove token: + * Example using remove token: * - * To remove your self-hosted runner from a repository, replace TOKEN with - * the remove token provided by this endpoint. + * To remove your self-hosted runner from a repository, replace TOKEN with + * the remove token provided by this endpoint. * - * ```config.sh remove --token TOKEN``` + * ```config.sh remove --token TOKEN``` */ post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. + * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a repository * @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/github-ae@latest/rest/guides/getting-started-with-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. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run * @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. */ get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Delete a specific workflow run. Anyone with write 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:write` permission to use - * this endpoint. + * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use + * this endpoint. */ delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow run artifacts * @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. */ get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run attempt * @description Gets 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. + * 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. */ get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run attempt * @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/github-ae@latest/rest/guides/getting-started-with-the-rest-api#parameters). */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. 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. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. 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. */ get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * 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. */ post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Force cancel a workflow run * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. - * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-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. + * 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. */ post: operations["actions/force-cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run * @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/github-ae@latest/rest/guides/getting-started-with-the-rest-api#parameters). */ get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. 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. + * `Location:` in the response header to find the URL for the download. 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. */ get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @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. */ delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a workflow * @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. */ post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get workflow run usage * @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 AE-hosted runners. Usage is listed for each GitHub AE-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-ae@latest/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. + * 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. */ get: operations["actions/get-workflow-run-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Anyone with read access to the repository can use this endpoint. + * If the repository is private you must use an access token with the `repo` scope. + * GitHub Apps must have the `secrets` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @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. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/github-ae@latest/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/github-ae@latest/rest/guides/encrypting-secrets-for-the-rest-api)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository 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. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `secrets` repository permission to use this endpoint. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. */ delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository workflows * @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. */ get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow * @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. */ get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Disable a workflow * @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`. * - * 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. + * 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. */ put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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`. * - * You 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)." + * You 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)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line)." + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line)." */ post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a workflow * @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`. * - * 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. + * 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. */ put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a workflow * @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/github-ae@latest/rest/guides/getting-started-with-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. + * 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. */ get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get workflow usage * @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 AE-hosted runners. Usage is listed for each GitHub AE-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-ae@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * 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. + * 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. */ get: operations["actions/get-workflow-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/github-ae@latest/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned * @description Checks if a user has permission to be assigned to an issue in this repository. * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. * - * Otherwise a `404` status code is returned. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an autolink reference of a repository * @description This returns a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List branches */ get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a branch */ get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get branch protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -2498,106 +5042,161 @@ export interface paths { * Update branch protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Protecting a branch requires admin or owner permissions to the repository. + * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get admin branch protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pull request review protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit signature protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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/github-ae@latest/articles/signing-commits-with-gpg) in GitHub Help. + * When 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/github-ae@latest/articles/signing-commits-with-gpg) in GitHub Help. * - * **Note**: You must enable branch protection to require signed commits. + * **Note**: You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * When 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. + * When 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. */ delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get status checks protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ patch: operations["repos/update-status-check-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all status check contexts * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -2618,1555 +5217,2593 @@ export interface paths { * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists who has access to this protected branch. + * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Disables the ability to restrict who can push to this branch. + * Disables the ability to restrict who can push to this branch. */ delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get apps with access to the protected branch * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists 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. + * Lists 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. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * 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-ae@latest/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. + * 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. */ put: operations["repos/set-app-access-restrictions"]; /** * 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-ae@latest/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. + * 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. */ post: operations["repos/add-app-access-restrictions"]; /** * 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-ae@latest/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. + * 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. */ delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get teams with access to the protected branch * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the teams who have push access to this branch. The list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified teams push access for this branch. You can also give push access to child teams. + * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get users with access to the protected branch * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the people who have push access to this branch. + * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ put: operations["repos/set-user-access-restrictions"]; /** * Add user 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified people push access for this branch. + * Grants the specified people push access for this branch. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ post: operations["repos/add-user-access-restrictions"]; /** * Remove user 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a user to push to this branch. + * Removes the ability of a user to push to this branch. * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check run * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check run * @description Gets a single check run using its `id`. * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. * - * To update a check run, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to update a check run. + * To update a check run, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to update a check run. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check run annotations * @description Lists annotations for a check run using the annotation `id`. * - * GitHub Apps - * must have the `checks:read` permission on a private repository or pull access to - * a public repository to get annotations for a check run. OAuth apps and authenticated - * users must have the `repo` scope to get annotations for a check run in a private - * repository. + * GitHub Apps + * must have the `checks:read` permission on a private repository or pull access to + * a public repository to get annotations for a check run. OAuth apps and authenticated + * users must have the `repo` scope to get annotations for a check run in a private + * repository. */ get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check run, you must use a GitHub App with the `checks:read` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check run. + * To rerequest a check run, you must use a GitHub App with the `checks:read` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check run. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/github-ae@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/github-ae@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". */ post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/github-ae@latest/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/github-ae@latest/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * To create a check suite, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to create a check suite. + * To create a check suite, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to create a check suite. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/github-ae@latest/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check suite * @description Gets a single check suite using its `id`. * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check suite, you must use a GitHub App with the `checks:write` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check suite. + * To rerequest a check suite, you must use a GitHub App with the `checks:write` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check suite. */ post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. + * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch (or for the specified Git reference if you used `ref` in the request). */ get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning alert * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories, the `public_repo` scope also grants permission to read security events on public repositories only. */ get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. */ patch: operations["code-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repositories, - * the `public_repo` scope also grants permission to read security events on public repositories only. + * You must use an access token with the `security_events` scope to use this endpoint with private repositories, + * the `public_repo` scope also grants permission to read security events on public repositories only. */ get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning analyses for a repository * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * You must use an access token with the `security_events` scope to use this endpoint with private repositories, - * the `public_repo` scope also grants permission to read security events on public repositories only. + * You must use an access token with the `security_events` scope to use this endpoint with private repositories, + * the `public_repo` scope also grants permission to read security events on public repositories only. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. */ get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. * - * You must use an access token with the `security_events` scope to use this endpoint with private repositories, - * the `public_repo` scope also grants permission to read security events on public repositories only. + * You must use an access token with the `security_events` scope to use this endpoint with private repositories, + * the `public_repo` scope also grants permission to read security events on public repositories only. * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. */ get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. For - * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` and `repo:security_events` scopes. - * GitHub Apps must have the `security_events` write permission to use this endpoint. - * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `analysis_key` - * * `environment` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * private repositories, you must use an access token with the `repo` scope. For public repositories, + * you must use an access token with `public_repo` and `repo:security_events` scopes. + * GitHub Apps must have the `security_events` write permission to use this endpoint. + * + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `analysis_key` + * * `environment` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set: + * `next_analysis_url` and `confirm_delete_url`. + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in a set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find an analysis that's identified as deletable. + * Each set of analyses always has one that's identified as deletable. + * Having found the deletable analysis for one of the two sets, + * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + * Then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. */ delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - 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)." * - * You 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: + * You 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: * - * ``` - * 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 these values. 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. + * ``` + * 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 these values. 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 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 | | - * | 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. | + * | **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 | | + * | 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. | * * - * The `202 Accepted` response includes an `id` value. - * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * The `202 Accepted` response includes an `id` value. + * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." */ post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repositories, the `public_repo` scope also grants permission to read security events on public repositories only. */ get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS - * file. + * file. * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * For more information about the correct CODEOWNERS syntax, + * see "[About code owners](https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this + * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this + * endpoint. */ get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is a repository collaborator * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this + * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this + * endpoint. */ get: operations["repos/check-collaborator"]; /** * Add a repository collaborator * @description This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * 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/github-ae@latest/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/github-ae@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-ae@latest/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: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github-ae@latest/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: * - * ``` - * Cannot assign {member} permission of {role name} - * ``` + * ``` + * Cannot assign {member} permission of {role name} + * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **Updating an existing collaborator's permission level** + * **Updating an existing collaborator's permission level** * - * The 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. + * The 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. */ put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. + * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages + * This endpoint also: + * - Cancels any outstanding invitations + * - Unasigns the user from any issues + * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. + * - Unstars the repository + * - Updates access permissions to packages * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + * Removing a user as a collaborator has the following effects on forks: + * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + * - If the user had their own fork of the repository, the fork will be deleted. + * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. + * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository permissions for a user * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * permissions are `admin`, `write`, `read`, and `none`. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the + * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. */ get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["repos/update-commit-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List branches for HEAD commit * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests associated with a commit * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * - * **Signature verification object** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the combined status for a specific reference * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * * - * Additionally, a combined `state` is returned. The `state` is one of: + * Additionally, a combined `state` is returned. The `state` is one of: * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` */ get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit statuses for a reference * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @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/github-ae@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * - * 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 API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. + * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. * - * **Working with large comparisons** + * **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: + * 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. + * - 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. * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api)." + * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api)." * - * **Signature verification object** + * **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 `verification` object includes the following fields: * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits-with-basehead"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit - * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. - * - * Files and symlinks support [a custom media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) for - * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/github-ae@latest/rest/overview/media-types) to ensure the content is returned in a consistent - * object format. - * - * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree). - * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * * This API supports files up to 1 megabyte in size. - * - * If the content is a directory: - * The response will be an array of objects, one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink: - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object - * describing the symlink itself. - * - * If the content is a submodule: - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out - * the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the - * github.com URLs (`html_url` and `_links["html"]`) will have null values. + * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * + * Files and symlinks support [a custom media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) for + * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media + * type](https://docs.github.com/github-ae@latest/rest/overview/media-types) to ensure the content is returned in a consistent + * object format. + * + * **Notes**: + * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree). + * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees + * API](https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree). + * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * * This API supports files up to 1 megabyte in size. + * + * If the content is a directory: + * The response will be an array of objects, one object for each item in the directory. + * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value + * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). + * In the next major version of the API, the type will be returned as "submodule". + * + * If the content is a symlink: + * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the + * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object + * describing the symlink itself. + * + * If the content is a submodule: + * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific + * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out + * the submodule at that specific commit. + * + * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the + * github.com URLs (`html_url` and `_links["html"]`) will have null values. */ get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/github-ae@latest/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/github-ae@latest/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/github-ae@latest/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/github-ae@latest/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository contributors * @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. * - * 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. + * 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. */ get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them - * before we merge a pull request. + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them + * before we merge a pull request. * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. * - * By default, [commit statuses](https://docs.github.com/github-ae@latest/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. + * By default, [commit statuses](https://docs.github.com/github-ae@latest/rest/commits/statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. + * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. * - * Merged branch response: + * Merged branch response: * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. * - * Merge conflict response: + * Merge conflict response: * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. * - * Failed commit status checks: + * Failed commit status checks: * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. */ post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deployment */ get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * 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. * - * To set a deployment as inactive, you must: + * To set a deployment as inactive, you must: * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. + * * 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/github-ae@latest/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/github-ae@latest/rest/deployments/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/github-ae@latest/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/github-ae@latest/rest/deployments/statuses#create-a-deployment-status)." */ delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. */ post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub AE to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#repository_dispatch)." * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This endpoint requires write access to the repository by providing either: + * This endpoint requires write access to the repository by providing either: * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. + * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. + * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * This input example shows how you can use the `client_payload` as a test to debug your workflow. */ post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environments * @description Lists the environments 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. + * 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. */ get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment * @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)." * - * 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. + * 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. */ get: operations["repos/get-environment"]; /** * Create or update an environment * @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)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description You must authenticate using an access token with the repo scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * 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. + * 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. */ get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment branch policy * @description Gets a deployment branch or tag policy for an environment. * - * 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. + * 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. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * */ get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List forks */ get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub AE Support](https://support.github.com/contact?tags=dotcom-rest-api). + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub AE Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * - **`application/vnd.github.raw+json`**: Returns the raw blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. * - * **Note** This endpoint supports blobs up to 100 megabytes in size. + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit object * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." + * + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List matching references * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a reference */ delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** Update a reference */ patch: operations["git/update-ref"]; + trace?: never; }; "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/github-ae@latest/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/github-ae@latest/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tag * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/github-ae@latest/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/github-ae@latest/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/github-ae@latest/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/github-ae@latest/rest/git/refs#update-a-reference)." * - * Returns an error if you try to delete a file that does not exist. + * Returns an error if you try to delete a file that does not exist. */ post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tree * @description Returns a single tree using the SHA1 value or ref name for that tree. * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. + * share the same `config` as long as those webhooks do not have any `events` that overlap. */ post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. */ get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. */ patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ patch: operations["repos/update-invitation"]; + trace?: never; }; "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/github-ae@latest/articles/disabling-issues/), the API returns a `410 Gone` status. * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments for a repository * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * - * By default, issue comments are ordered by ascending ID. + * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events for a repository * @description Lists events for a repository. */ get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue event * @description Gets a single event by the event id. */ get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/github-ae@latest/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/github-ae@latest/webhooks/event-payloads/#issues) webhook. + * [transferred](https://docs.github.com/github-ae@latest/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * 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/github-ae@latest/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 - * 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/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. @@ -4177,59 +7814,107 @@ export interface paths { * @description Removes one or more assignees from an issue. */ delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned to a issue * @description 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. + * 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. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * Issue comments are ordered by ascending ID. + * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events * @description Lists all events for an issue. */ get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for an issue * @description Lists all labels for an issue. @@ -4250,179 +7935,399 @@ export interface paths { * @description Removes all labels from an issue. */ delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List deploy keys */ get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deploy key */ get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a repository * @description Lists all labels for a repository. */ get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a label * @description Gets a label using the given name. */ get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ patch: operations["issues/update-label"]; + trace?: never; }; "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable Git LFS for a repository * @description Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. */ put: operations["repos/enable-lfs-for-repo"]; + post?: never; /** * Disable Git LFS for a repository * @description Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. */ delete: operations["repos/disable-lfs-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List milestones * @description Lists milestones for a repository. */ get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ patch: operations["issues/update-milestone"]; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. @@ -4433,320 +8338,516 @@ export interface paths { * @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 AE 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/github-ae@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GitHub AE Pages site * @description Gets information about a GitHub AE Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub AE Pages site * @description Updates information for a GitHub AE 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 `administration:write` and `pages:write` permissions. + * 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 `administration:write` and `pages:write` permissions. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub AE Pages site * @description Configures a GitHub AE 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 `administration:write` and `pages:write` permissions. + * 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 `administration:write` and `pages:write` permissions. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub AE Pages site * @description Deletes a GitHub AE 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 `administration:write` and `pages:write` permissions. + * 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 `administration:write` and `pages:write` permissions. */ delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub AE Pages builds * @description Lists builts of a GitHub AE Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. */ get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub AE Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get latest Pages build * @description Gets information about the single most recent build of a GitHub AE Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. */ get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub AE Pages build * @description Gets information about a GitHub AE Pages build. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. */ get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-repo"]; + put?: never; /** * Create a repository project * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests * @description Lists pull requests in a specified repository. * - * 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-ae@latest/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. + * 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-ae@latest/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - * - **`application/vnd.github.patch`**: For more information, see "[git-format-patch](https://git-scm.com/docs/git-format-patch)" in the Git documentation. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.patch`**: For more information, see "[git-format-patch](https://git-scm.com/docs/git-format-patch)" in the Git documentation. */ get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments in a repository * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. + * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists details of a pull request by providing its number. + * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/github-ae@latest/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/github-ae@latest/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/github-ae@latest/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/github-ae@latest/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * Pass the appropriate [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * Pass the appropriate [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ patch: operations["pulls/update"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments on a pull request * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. + * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#create-an-issue-comment)." * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reply for a review comment * @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. * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/github-ae@latest/rest/commits/commits#list-commits) - * endpoint. + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/github-ae@latest/rest/commits/commits#list-commits) + * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. @@ -4755,16 +8856,29 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. @@ -4775,390 +8889,741 @@ export interface paths { * @description Removes review requests from a pull request for a given set of users and/or teams. */ delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified pull request. * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." * - * 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/github-ae@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/github-ae@latest/rest/pulls/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. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) endpoint. * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/github-ae@latest/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/github-ae@latest/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List releases * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/github-ae@latest/rest/repos/repos#list-repository-tags). * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description Users with push access to the repository can create a release. * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release asset * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/github-ae@latest/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ patch: operations["repos/update-release-asset"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the latest release * @description View the latest published full release for the repository. * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ patch: operations["repos/update-release"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List release assets */ get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/github-ae@latest/rest/releases/releases#create-a-release) to upload a release asset. + * the response of the [Create a release endpoint](https://docs.github.com/github-ae@latest/rest/releases/releases#create-a-release) to upload a release asset. * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: * - * `application/zip` + * `application/zip` * - * GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. + * GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * - * **Notes:** - * * GitHub AE renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/github-ae@latest/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub AE Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/github-ae@latest/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + * **Notes:** + * * GitHub AE renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/github-ae@latest/rest/releases/assets#list-release-assets)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub AE Support](https://support.github.com/contact?tags=dotcom-rest-api). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/github-ae@latest/rest/releases/releases#get-the-latest-release). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description 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 organization, and you must use an access token with the `repo` scope or `security_events` scope. * - * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. */ patch: operations["secret-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. */ get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit activity * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all contributor commit activity * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit count * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * - * The array order is oldest week (index 0) to most recent week. + * The array order is oldest week (index 0) to most recent week. * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. + * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the hourly commit count for each day * @description Each array contains the day number, hour number, and number of commits: * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List watchers * @description Lists the people watching the specified repository. */ get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. @@ -5169,339 +9634,601 @@ export interface paths { * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/github-ae@latest/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/github-ae@latest/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List repository tags */ get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (tar) * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * `main`) 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. */ get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository teams * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. * - * For a public repository, a team is listed only if that team added the public repository explicitly. + * For a public repository, a team is listed only if that team added the public repository explicitly. * - * Personal access tokens require the following scopes: - * * `public_repo` to call this endpoint on a public repository - * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) + * Personal access tokens require the following scopes: + * * `public_repo` to call this endpoint on a public repository + * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) * - * This endpoint is not compatible with fine-grained personal access tokens. + * This endpoint is not compatible with fine-grained personal access tokens. */ get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all repository topics */ get: operations["repos/get-all-topics"]; /** Replace all repository topics */ put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/github-ae@latest/articles/about-repository-transfers/). - * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. + * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. */ post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (zip) * @description 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 - * the `Location` header to make a second `GET` request. + * `main`) 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. + * **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. */ get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * **OAuth scope requirements** + * **OAuth scope requirements** * - * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository */ post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * - * `q=addClass+in:file+language:js+repo:jquery/jquery` + * `q=addClass+in:file+language:js+repo:jquery/jquery` * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. * - * Considerations for code search: + * Considerations for code search: * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. * - * This endpoint requires you to authenticate and limits you to 10 requests per minute. + * This endpoint requires you to authenticate and limits you to 10 requests per minute. */ get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search commits * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). * - * 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/github-ae@latest/rest/search/search#text-match-metadata). + * 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/github-ae@latest/rest/search/search#text-match-metadata). * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * - * `q=repo:octocat/Spoon-Knife+css` + * `q=repo:octocat/Spoon-Knife+css` */ get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search issues and pull requests * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github-ae@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github-ae@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * - * `q=bug+defect+enhancement&repository_id=64778136` + * `q=bug+defect+enhancement&repository_id=64778136` * - * The labels that best match the query appear first in the search results. + * The labels that best match the query appear first in the search results. */ get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * - * `q=tetris+language:assembly&sort=stars&order=desc` + * `q=tetris+language:assembly&sort=stars&order=desc` * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/github-ae@latest/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * - * `q=ruby+is:featured` + * `q=ruby+is:featured` * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). * - * For example, if you're looking for a list of popular users, you might try this query: + * For example, if you're looking for a list of popular users, you might try this query: * - * `q=tom+repos:%3E42+followers:%3E1000` + * `q=tom+repos:%3E42+followers:%3E1000` * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/github-ae@latest/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/github-ae@latest/graphql/reference/queries#search)." */ get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/github-ae@latest/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/github-ae@latest/rest/teams/teams#delete-a-team) endpoint. * - * To delete a team, the authenticated user must be an organization owner or team maintainer. + * To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/github-ae@latest/rest/teams/teams#update-a-team) endpoint. * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/github-ae@latest/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["teams/list-discussions-legacy"]; + put?: never; /** * Create a discussion (Legacy) * @deprecated * @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/github-ae@latest/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["teams/create-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["teams/get-discussion-legacy"]; + put?: never; + post?: never; /** * Delete a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/github-ae@latest/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["teams/delete-discussion-legacy"]; + options?: never; + head?: never; /** * Update a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ patch: operations["teams/update-discussion-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["teams/list-discussion-comments-legacy"]; + put?: never; /** * Create a discussion comment (Legacy) * @deprecated * @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/github-ae@latest/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." + * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["teams/create-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["teams/get-discussion-comment-legacy"]; + put?: never; + post?: never; /** * Delete a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["teams/delete-discussion-comment-legacy"]; + options?: never; + head?: never; /** * Update a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ patch: operations["teams/update-discussion-comment-legacy"]; + trace?: never; }; "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/github-ae@latest/rest/teams/members#list-team-members) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. */ get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team member (Legacy) * @deprecated * @description The "Get team member" endpoint (described below) is deprecated. * - * We recommend using the [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/get-member-legacy"]; /** @@ -5509,46 +10236,57 @@ export interface paths { * @deprecated * @description The "Add team member" endpoint (described below) is deprecated. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated * @description The "Remove team member" endpoint (described below) is deprecated. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#get-team-membership-for-a-user) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** @@ -5556,47 +10294,71 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * - * If 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. + * If 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. */ put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/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. + * 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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/github-ae@latest/rest/teams/teams#list-team-projects) endpoint. * - * Lists the organization projects for a team. + * Lists the organization projects for a team. */ get: operations["teams/list-projects-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/github-ae@latest/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ get: operations["teams/check-permissions-for-project-legacy"]; /** @@ -5604,35 +10366,59 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/github-ae@latest/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ put: operations["teams/add-or-update-project-permissions-legacy"]; + post?: never; /** * Remove a project from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/github-ae@latest/rest/teams/teams#remove-a-project-from-a-team) endpoint. * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ delete: operations["teams/remove-project-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/github-ae@latest/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository (Legacy) * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/github-ae@latest/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/github-ae@latest/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** @@ -5640,310 +10426,621 @@ export interface paths { * @deprecated * @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/github-ae@latest/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * - * 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. + * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/github-ae@latest/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/github-ae@latest/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated user * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. * - * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. */ get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ patch: operations["users/update-authenticated"]; + trace?: never; }; "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a person is followed by the authenticated user */ get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. */ delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for the authenticated user * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GPG key for the authenticated user * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * You must use a [user access token](https://docs.github.com/github-ae@latest/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. + * You must use a [user access token](https://docs.github.com/github-ae@latest/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You can find the permissions for the installation under the `permissions` key. + * You can find the permissions for the installation under the `permissions` key. */ get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the user access token * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You must use a [user access token](https://docs.github.com/github-ae@latest/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. + * You must use a [user access token](https://docs.github.com/github-ae@latest/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. * - * The access the user has to each repository is included in the hash under the `permissions` key. + * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user account issues assigned to the authenticated user * @description 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 - * 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/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public SSH keys for the authenticated user * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a public SSH key for the authenticated user * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user migrations * @description Lists all migrations a user has started. */ get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a user migration archive * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * **OAuth scope requirements** + * **OAuth scope requirements** * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user project * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for the authenticated user * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * **OAuth scope requirements** + * **OAuth scope requirements** * - * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: + * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository + * * `public_repo` scope or `repo` scope to create a public repository + * * `repo` scope to create a private repository */ post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. @@ -5954,238 +11051,526 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams for the authenticated user * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/github-ae@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. */ get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub AE. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below" + * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below" * - * The `email` key in the following response is the publicly visible email address from your GitHub AE [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see [Authentication](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub AE [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see [Authentication](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/github-ae@latest/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/github-ae@latest/rest/users/emails)". */ get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. */ get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of a user * @description Lists the people following the specified user. */ get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a user follows another user */ get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for a user * @description Lists public gists for the specified user: */ get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get contextual information for a user * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * ```shell + * curl -u username:token + * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 + * ``` */ get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for a user * @description List [public organization memberships](https://docs.github.com/github-ae@latest/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/github-ae@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/github-ae@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user projects * @description Lists projects for a user. */ get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/github-ae@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. * - * You can suspend any user account except your own. + * You can suspend any user account except your own. * - * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["enterprise-admin/suspend-user"]; + post?: never; /** * Unsuspend a user * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/github-ae@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. */ delete: operations["enterprise-admin/unsuspend-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{base}...{head}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. * - * 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. + * 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. * - * 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. + * 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** + * **Working with large comparisons** * - * 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)." + * 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)." * - * 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. + * 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** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } - export type webhooks = Record; - export interface components { schemas: { root: { @@ -6435,11 +11820,11 @@ export interface components { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ "app-permissions": { /** @@ -6739,12 +12124,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** * Format: uri @@ -6833,9 +12216,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -6848,9 +12231,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -7209,12 +12592,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -7449,7 +12830,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -7488,7 +12869,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -7509,7 +12890,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -7625,38 +13006,38 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -7682,12 +13063,10 @@ export interface components { single_file?: string; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; }; /** @@ -7704,53 +13083,52 @@ export interface components { * @example https://api.github.com/codes_of_conduct/contributor_covenant */ url: string; - /** - * @example # Contributor Covenant Code of Conduct + /** @example # Contributor Covenant Code of Conduct * - * ## Our Pledge + * ## Our Pledge * - * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. * - * ## Our Standards + * ## Our Standards * - * Examples of behavior that contributes to creating a positive environment include: + * Examples of behavior that contributes to creating a positive environment include: * - * * Using welcoming and inclusive language - * * Being respectful of differing viewpoints and experiences - * * Gracefully accepting constructive criticism - * * Focusing on what is best for the community - * * Showing empathy towards other community members + * * Using welcoming and inclusive language + * * Being respectful of differing viewpoints and experiences + * * Gracefully accepting constructive criticism + * * Focusing on what is best for the community + * * Showing empathy towards other community members * - * Examples of unacceptable behavior by participants include: + * Examples of unacceptable behavior by participants include: * - * * The use of sexualized language or imagery and unwelcome sexual attention or advances - * * Trolling, insulting/derogatory comments, and personal or political attacks - * * Public or private harassment - * * Publishing others' private information, such as a physical or electronic address, without explicit permission - * * Other conduct which could reasonably be considered inappropriate in a professional setting + * * The use of sexualized language or imagery and unwelcome sexual attention or advances + * * Trolling, insulting/derogatory comments, and personal or political attacks + * * Public or private harassment + * * Publishing others' private information, such as a physical or electronic address, without explicit permission + * * Other conduct which could reasonably be considered inappropriate in a professional setting * - * ## Our Responsibilities + * ## Our Responsibilities * - * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - * to any instances of unacceptable behavior. + * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + * to any instances of unacceptable behavior. * - * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. * - * ## Scope + * ## Scope * - * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. * - * ## Enforcement + * ## Enforcement * - * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. * - * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. * - * ## Attribution + * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - */ + * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + * */ body?: string; /** Format: uri */ html_url: string | null; @@ -7897,12 +13275,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -7983,12 +13361,10 @@ export interface components { * @example 2016-07-11T22:14:10Z */ expires_at: string; - /** - * @example { - * "issues": "read", - * "deployments": "write" - * } - */ + /** @example { + * "issues": "read", + * "deployments": "write" + * } */ permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; @@ -8063,27 +13439,27 @@ export interface components { visibility?: string; }; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "nullable-alert-updated-at": string | null; + "nullable-alert-updated-at": string | null; /** * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} @@ -8361,10 +13737,8 @@ export interface components { resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -8410,11 +13784,9 @@ export interface components { current_user_actor_url?: string; /** @example https://github.com/octocat-org */ current_user_organization_url?: string; - /** - * @example [ - * "https://github.com/organizations/github/octocat.private.atom?token=abc123" - * ] - */ + /** @example [ + * "https://github.com/organizations/github/octocat.private.atom?token=abc123" + * ] */ current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ security_advisories_url?: string; @@ -8461,13 +13833,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -8608,13 +13982,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -8640,15 +14016,17 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; + [key: string]: + | ({ + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + } | null) + | undefined; }; public?: boolean; created_at?: string; @@ -8738,25 +14116,24 @@ export interface components { "gitignore-template": { /** @example C */ name: string; - /** - * @example # Object files - * *.o + /** @example # Object files + * *.o * - * # Libraries - * *.lib - * *.a + * # Libraries + * *.lib + * *.a * - * # Shared objects (inc. Windows DLLs) - * *.dll - * *.so - * *.so.* - * *.dylib + * # Shared objects (inc. Windows DLLs) + * *.dll + * *.so + * *.so.* + * *.dylib * - * # Executables - * *.exe - * *.out - * *.app - */ + * # Executables + * *.exe + * *.out + * *.app + * */ source: string; }; /** @@ -8876,9 +14253,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -8891,9 +14268,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -8977,14 +14354,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -8994,9 +14370,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -9080,53 +14455,46 @@ export interface components { description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ implementation: string; - /** - * @example [ - * "commercial-use", - * "modifications", - * "distribution", - * "sublicense", - * "private-use" - * ] - */ + /** @example [ + * "commercial-use", + * "modifications", + * "distribution", + * "sublicense", + * "private-use" + * ] */ permissions: string[]; - /** - * @example [ - * "include-copyright" - * ] - */ + /** @example [ + * "include-copyright" + * ] */ conditions: string[]; - /** - * @example [ - * "no-liability" - * ] - */ + /** @example [ + * "no-liability" + * ] */ limitations: string[]; - /** - * @example + /** @example * - * The MIT License (MIT) + * The MIT License (MIT) * - * Copyright (c) [year] [fullname] + * Copyright (c) [year] [fullname] * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * */ body: string; /** @example true */ featured: boolean; @@ -9144,65 +14512,45 @@ export interface components { SHA256_ECDSA?: string; SHA256_ED25519?: string; }; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ hooks?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ github_enterprise_importer?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ web?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ api?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ git?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ pages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ importer?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ actions?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ dependabot?: string[]; domains?: { website?: string[]; @@ -9625,47 +14973,47 @@ export interface components { /** * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; @@ -9736,12 +15084,12 @@ export interface components { * @description If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified. * @default false */ - workflow_restrictions_read_only?: boolean; + workflow_restrictions_read_only: boolean; /** * @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array. * @default false */ - restricted_to_workflows?: boolean; + restricted_to_workflows: boolean; /** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */ selected_workflows?: string[]; }; @@ -9828,12 +15176,12 @@ export interface components { * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string} @@ -9843,12 +15191,12 @@ export interface components { * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. * @enum {string|null} @@ -9883,10 +15231,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ "code-scanning-analysis-analysis-key": string; @@ -9924,10 +15270,8 @@ export interface components { }; location?: components["schemas"]["code-scanning-alert-location"]; html_url?: string; - /** - * @description Classifications that have been applied to the file that triggered the alert. - * For example identifying it as documentation, or a generated file. - */ + /** @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. */ classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; "code-scanning-organization-alert-items": { @@ -9970,15 +15314,15 @@ export interface components { /** * @description An array of teams linked to this group * @example [ - * { - * "team_id": 1, - * "team_name": "team-test" - * }, - * { - * "team_id": 2, - * "team_name": "team-test2" - * } - * ] + * { + * "team_id": 1, + * "team_name": "team-test" + * }, + * { + * "team_id": 2, + * "team_name": "team-test2" + * } + * ] */ teams: { /** @@ -9995,19 +15339,19 @@ export interface components { /** * @description An array of external members linked to this group * @example [ - * { - * "member_id": 1, - * "member_login": "mona-lisa_eocsaxrs", - * "member_name": "Mona Lisa", - * "member_email": "mona_lisa@github.com" - * }, - * { - * "member_id": 2, - * "member_login": "octo-lisa_eocsaxrs", - * "member_name": "Octo Lisa", - * "member_email": "octo_lisa@github.com" - * } - * ] + * { + * "member_id": 1, + * "member_login": "mona-lisa_eocsaxrs", + * "member_name": "Mona Lisa", + * "member_email": "mona_lisa@github.com" + * }, + * { + * "member_id": 2, + * "member_login": "octo-lisa_eocsaxrs", + * "member_name": "Octo Lisa", + * "member_email": "octo_lisa@github.com" + * } + * ] */ members: { /** @@ -10040,17 +15384,17 @@ export interface components { /** * @description An array of external groups available to be mapped to a team * @example [ - * { - * "group_id": 1, - * "group_name": "group-azuread-test", - * "updated_at": "2021-01-03 22:27:15:000 -700" - * }, - * { - * "group_id": 2, - * "group_name": "group-azuread-test2", - * "updated_at": "2021-06-03 22:27:15:000 -700" - * } - * ] + * { + * "group_id": 1, + * "group_name": "group-azuread-test", + * "updated_at": "2021-01-03 22:27:15:000 -700" + * }, + * { + * "group_id": 2, + * "group_name": "group-azuread-test2", + * "updated_at": "2021-06-03 22:27:15:000 -700" + * } + * ] */ groups?: { /** @@ -10094,12 +15438,10 @@ export interface components { deliveries_url?: string; /** @example web */ name: string; - /** - * @example [ - * "push", - * "pull_request" - * ] - */ + /** @example [ + * "push", + * "pull_request" + * ] */ events: string[]; /** @example true */ active: boolean; @@ -10470,7 +15812,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -10509,7 +15851,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -10530,7 +15872,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -10646,38 +15988,38 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -10886,14 +16228,12 @@ export interface components { open_issues_count: number; /** @example true */ is_template?: boolean; - /** - * @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] - */ + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ topics?: string[]; /** @example true */ has_issues: boolean; @@ -10972,7 +16312,7 @@ export interface components { * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; + anonymous_access_enabled: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; }; @@ -11691,7 +17031,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -11729,7 +17069,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -11750,44 +17090,44 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - allow_forking?: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -12075,10 +17415,10 @@ export interface components { /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ - * "self-hosted", - * "foo", - * "bar" - * ] + * "self-hosted", + * "foo", + * "bar" + * ] */ labels: string[]; /** @@ -12862,11 +18202,9 @@ export interface components { url: string; /** @example true */ strict: boolean; - /** - * @example [ - * "continuous-integration/travis-ci" - * ] - */ + /** @example [ + * "continuous-integration/travis-ci" + * ] */ contexts: string[]; checks: { /** @example continuous-integration/travis-ci */ @@ -13296,12 +18634,12 @@ export interface components { * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; + "code-scanning-analysis-url": string; "code-scanning-analysis": { ref: components["schemas"]["code-scanning-ref"]; commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; @@ -13336,16 +18674,16 @@ export interface components { * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + readonly next_analysis_url: string | null; /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; + readonly confirm_delete_url: string | null; }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -13357,7 +18695,7 @@ export interface components { * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; + readonly url?: string; }; "code-scanning-sarifs-status": { /** @@ -13369,9 +18707,9 @@ export interface components { * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** * CODEOWNERS errors @@ -13408,8 +18746,8 @@ export interface components { * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: * - * * user - * ^ + * * user + * ^ */ message: string; /** @@ -14166,14 +19504,11 @@ export interface components { * @example deploy */ task: string; - payload: OneOf< - [ - { + payload: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** @example staging */ original_environment?: string; /** @@ -14255,7 +19590,7 @@ export interface components { * @default * @example production */ - environment?: string; + environment: string; /** * Format: uri * @description Deprecated: the URL to associate with this status. @@ -14289,14 +19624,14 @@ export interface components { * @default * @example https://staging.example.com/ */ - environment_url?: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - log_url?: string; + log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** @@ -14426,8 +19761,8 @@ export interface components { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -14443,8 +19778,8 @@ export interface components { /** * @description The name pattern that branches must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -14716,43 +20051,43 @@ export interface components { /** * @description Objects specifying a tree structure * @example [ - * { - * "path": "file.rb", - * "mode": "100644", - * "type": "blob", - * "size": 30, - * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" + * { + * "path": "file.rb", + * "mode": "100644", + * "type": "blob", + * "size": 30, + * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", + * "properties": { + * "path": { + * "type": "string" + * }, + * "mode": { + * "type": "string" + * }, + * "type": { + * "type": "string" + * }, + * "size": { + * "type": "integer" + * }, + * "sha": { + * "type": "string" + * }, + * "url": { + * "type": "string" + * } + * }, + * "required": [ + * "path", + * "mode", + * "type", + * "sha", + * "url", + * "size" + * ] * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" * ] - * } - * ] */ tree: { /** @example test/file.rb */ @@ -14799,9 +20134,9 @@ export interface components { /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ - * "push", - * "pull_request" - * ] + * "push", + * "pull_request" + * ] */ events: string[]; config: components["schemas"]["webhook-config"]; @@ -14925,14 +20260,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -14942,9 +20276,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -15746,7 +21079,7 @@ export interface components { * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -15762,7 +21095,7 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} @@ -15886,7 +21219,7 @@ export interface components { * @description Language */ language: { - [key: string]: number; + [key: string]: number | undefined; }; /** * License Content @@ -16026,9 +21359,9 @@ export interface components { /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ - * "example.com", - * "www.example.com" - * ] + * "example.com", + * "www.example.com" + * ] */ domains: string[]; /** Format: date */ @@ -16842,13 +22175,13 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -17171,17 +22504,15 @@ export interface components { * @description Commit Activity */ "commit-activity": { - /** - * @example [ - * 0, - * 3, - * 26, - * 20, - * 39, - * 1, - * 0 - * ] - */ + /** @example [ + * 0, + * 3, + * 26, + * 20, + * 39, + * 1, + * 0 + * ] */ days: number[]; /** @example 89 */ total: number; @@ -17196,16 +22527,14 @@ export interface components { author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ total: number; - /** - * @example [ - * { - * "w": "1367712000", - * "a": 6898, - * "d": 77, - * "c": 10 - * } - * ] - */ + /** @example [ + * { + * "w": "1367712000", + * "a": 6898, + * "d": 77, + * "c": 10 + * } + * ] */ weeks: { w?: number; a?: number; @@ -17309,12 +22638,10 @@ export interface components { language?: string | null; /** Format: date-time */ last_modified_at?: string; - /** - * @example [ - * "73..77", - * "77..78" - * ] - */ + /** @example [ + * "73..77", + * "77..78" + * ] */ line_numbers?: string[]; text_matches?: components["schemas"]["search-result-text-matches"]; }; @@ -17805,36 +23132,32 @@ export interface components { key_id: string; /** @example xsBNBFayYZ... */ public_key: string; - /** - * @example [ - * { - * "email": "octocat@users.noreply.github.com", - * "verified": true - * } - * ] - */ + /** @example [ + * { + * "email": "octocat@users.noreply.github.com", + * "verified": true + * } + * ] */ emails: { email?: string; verified?: boolean; }[]; - /** - * @example [ - * { - * "id": 4, - * "primary_key_id": 3, - * "key_id": "4A595D4C72EE49C7", - * "public_key": "zsBNBFayYZ...", - * "emails": [], - * "can_sign": false, - * "can_encrypt_comms": true, - * "can_encrypt_storage": true, - * "can_certify": false, - * "created_at": "2016-03-24T11:31:04-06:00", - * "expires_at": null, - * "revoked": false - * } - * ] - */ + /** @example [ + * { + * "id": 4, + * "primary_key_id": 3, + * "key_id": "4A595D4C72EE49C7", + * "public_key": "zsBNBFayYZ...", + * "emails": [], + * "can_sign": false, + * "can_encrypt_comms": true, + * "can_encrypt_storage": true, + * "can_certify": false, + * "created_at": "2016-03-24T11:31:04-06:00", + * "expires_at": null, + * "revoked": false + * } + * ] */ subkeys: { id?: number; primary_key_id?: number; @@ -17915,8 +23238,9 @@ export interface components { /** * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured - * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/github-ae@latest/admin/overview/about-enterprise-accounts)." + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/github-ae@latest/admin/overview/about-enterprise-accounts)." + * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -17964,8 +23288,8 @@ export interface components { /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured - * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/github-ae@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * for and sent to a GitHub App. For more information, + * see "[Using webhooks with GitHub Apps](https://docs.github.com/github-ae@latest/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -17982,7 +23306,7 @@ export interface components { /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an - * organization, or when the event occurs from activity in a repository owned by an organization. + * organization, or when the event occurs from activity in a repository owned by an organization. */ "organization-simple-webhooks": { /** @example github */ @@ -18022,7 +23346,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "repository-webhooks": { /** @@ -18224,7 +23548,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -18262,7 +23586,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -18283,7 +23607,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -18399,38 +23723,38 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -18636,15 +23960,15 @@ export interface components { /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -18659,7 +23983,7 @@ export interface components { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -18669,7 +23993,7 @@ export interface components { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -18683,14 +24007,14 @@ export interface components { readonly vector_string: string | null; }; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -18700,7 +24024,7 @@ export interface components { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -18727,7 +24051,7 @@ export interface components { * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; /** @description A Dependabot alert. */ "dependabot-alert": { number: components["schemas"]["alert-number"]; @@ -18735,10 +24059,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -18869,8 +24193,8 @@ export interface components { repository_url: string; /** * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. * @enum {string} */ state: "open" | "closed" | "locked" | "converting" | "transferring"; @@ -18925,7 +24249,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** @@ -19127,7 +24451,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -19165,7 +24489,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -19186,7 +24510,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -19302,38 +24626,38 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -21173,7 +26497,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: Record | null; + dismissed_by: Record; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -22342,7 +27666,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -22729,7 +28053,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -23123,7 +28447,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -23453,7 +28777,7 @@ export interface components { id: number; node_id: string; original_environment: string; - payload: string | Record | null; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -25060,24 +30384,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -25117,7 +30441,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -25256,7 +30580,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -25339,7 +30663,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: Record | null; + license?: Record; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -26385,7 +31709,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -26412,10 +31736,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -27066,7 +32390,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -27093,10 +32417,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -27756,7 +33080,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -27783,10 +33107,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -28834,8 +34158,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -28845,13 +34169,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -29848,8 +35172,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -29859,7 +35183,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; /** @@ -29935,7 +35259,7 @@ export interface components { } | null; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -31536,8 +36860,8 @@ export interface components { | "too heated" | "spam" | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -31547,14 +36871,14 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; /** @enum {boolean} */ locked: true; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -32071,8 +37395,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -32082,7 +37406,7 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; /** @@ -32158,7 +37482,7 @@ export interface components { }; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -32756,24 +38080,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -32809,7 +38133,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -32950,7 +38274,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -34418,8 +39742,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -34429,13 +39753,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -34963,24 +40287,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -35016,7 +40340,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -35160,7 +40484,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -37162,8 +42486,8 @@ export interface components { } | null; } & { active_lock_reason: unknown; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37173,11 +42497,11 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; /** @enum {boolean} */ locked: false; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; performed_via_github_app?: unknown; @@ -39118,11 +44442,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string; + [key: string]: string | undefined; }; repo?: string; dependencies?: { - [key: string]: string; + [key: string]: string | undefined; }[]; commit_oid?: string; }; @@ -39222,8 +44546,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -39248,19 +44572,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: Record | null; - bugs?: Record | null; + author?: Record; + bugs?: Record; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: Record | null; + dist?: Record; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: Record | null; + repository?: Record; scripts?: Record; id?: string; node_version?: string; @@ -39273,7 +44597,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: Record | null; + directories?: Record; os?: string[]; cpu?: string[]; readme?: string; @@ -39287,19 +44611,16 @@ export interface components { | { id?: number | string; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -40923,24 +46244,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -40976,7 +46297,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -41060,17 +46381,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -41137,7 +46458,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -41145,9 +46466,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -41157,8 +46478,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -41190,7 +46511,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -41266,24 +46587,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -41319,7 +46640,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -41403,17 +46724,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -41480,7 +46801,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -41488,9 +46809,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -41500,8 +46821,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -41533,7 +46854,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -41723,9 +47044,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -41760,8 +47080,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -41811,9 +47131,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -42135,24 +47454,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -42188,7 +47507,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -42272,17 +47591,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -42349,7 +47668,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -42357,9 +47676,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -42369,8 +47688,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -42402,7 +47721,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -42478,24 +47797,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -42531,7 +47850,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -42615,17 +47934,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -42692,7 +48011,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -42700,9 +48019,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -42712,8 +48031,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -42745,7 +48064,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -42935,9 +48254,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -42972,8 +48290,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -43023,9 +48341,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -43348,24 +48665,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -43401,7 +48718,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -43485,17 +48802,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -43562,7 +48879,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -43570,9 +48887,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -43582,8 +48899,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -43615,7 +48932,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -43691,24 +49008,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -43744,7 +49061,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -43828,17 +49145,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -43905,7 +49222,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -43913,9 +49230,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -43925,8 +49242,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -43958,7 +49275,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -44148,9 +49465,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -44185,8 +49501,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -44236,9 +49552,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -44364,41 +49679,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -44406,7 +49721,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -44425,41 +49740,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -44467,7 +49782,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -44684,24 +49999,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -44737,7 +50052,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -44821,17 +50136,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -44898,7 +50213,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -44906,9 +50221,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -44918,8 +50233,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -44951,7 +50266,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45027,24 +50342,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -45080,7 +50395,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -45164,17 +50479,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -45241,7 +50556,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -45249,9 +50564,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -45261,8 +50576,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -45294,7 +50609,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -45484,9 +50799,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45521,8 +50835,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -45572,9 +50886,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -45718,41 +51031,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -45760,7 +51073,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; @@ -45993,24 +51306,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46046,7 +51359,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46130,17 +51443,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46207,7 +51520,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46215,9 +51528,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46227,8 +51540,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46260,7 +51573,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46336,24 +51649,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46389,7 +51702,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46473,17 +51786,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46550,7 +51863,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46558,9 +51871,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46570,8 +51883,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46603,7 +51916,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46793,9 +52106,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -46830,8 +52142,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -46881,9 +52193,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -47206,24 +52517,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47259,7 +52570,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47343,17 +52654,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47420,7 +52731,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47428,9 +52739,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47440,8 +52751,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47473,7 +52784,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -47549,24 +52860,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47602,7 +52913,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47686,17 +52997,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47763,7 +53074,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47771,9 +53082,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47783,8 +53094,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47816,7 +53127,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48006,9 +53317,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48043,8 +53353,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -48094,9 +53404,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -48419,24 +53728,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48472,7 +53781,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48556,17 +53865,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48633,7 +53942,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48641,9 +53950,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48653,8 +53962,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48686,7 +53995,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48762,24 +54071,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48815,7 +54124,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48899,17 +54208,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48976,7 +54285,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48984,9 +54293,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48996,8 +54305,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49029,7 +54338,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -49219,9 +54528,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49256,8 +54564,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -49307,9 +54615,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -49434,41 +54741,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49476,7 +54783,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -49495,41 +54802,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49537,7 +54844,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -49556,41 +54863,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49598,7 +54905,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -49964,24 +55271,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50017,7 +55324,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50101,17 +55408,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50178,7 +55485,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50186,9 +55493,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50198,8 +55505,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50231,7 +55538,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50300,24 +55607,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50353,7 +55660,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50402,7 +55709,7 @@ export interface components { * @description Whether discussions are enabled. * @default false */ - has_discussions?: boolean; + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -50437,17 +55744,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50514,7 +55821,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50522,9 +55829,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50534,8 +55841,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50567,7 +55874,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50712,9 +56019,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50749,8 +56055,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -50800,9 +56106,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -51268,24 +56573,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51321,7 +56626,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51405,17 +56710,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51482,7 +56787,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51490,9 +56795,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51502,8 +56807,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51535,7 +56840,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51604,24 +56909,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51657,7 +56962,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51741,17 +57046,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51818,7 +57123,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51826,9 +57131,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51838,8 +57143,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51871,7 +57176,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52016,9 +57321,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52053,8 +57357,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -52104,9 +57408,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -52579,24 +57882,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52632,7 +57935,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52716,17 +58019,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52793,7 +58096,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52801,9 +58104,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52813,8 +58116,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52846,7 +58149,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52915,24 +58218,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52968,7 +58271,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53052,17 +58355,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53129,7 +58432,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53137,9 +58440,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53149,8 +58452,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53182,7 +58485,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53327,9 +58630,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53364,8 +58666,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -53415,9 +58717,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -53731,24 +59032,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53784,7 +59085,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53868,17 +59169,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53945,7 +59246,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53953,9 +59254,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53965,8 +59266,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53998,7 +59299,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54067,24 +59368,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54120,7 +59421,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54204,17 +59505,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -54281,7 +59582,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54289,9 +59590,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -54301,8 +59602,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -54334,7 +59635,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54479,9 +59780,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54516,8 +59816,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -54567,9 +59867,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -54970,24 +60269,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55023,7 +60322,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55162,7 +60461,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55257,24 +60556,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55310,7 +60609,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55449,7 +60748,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55620,9 +60919,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55657,8 +60955,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -55708,9 +61006,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -55896,9 +61193,8 @@ export interface components { sender: components["schemas"]["simple-user-webhooks"]; }; /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": OneOf< - [ - { + "webhook-pull-request-review-request-removed": + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -56109,24 +61405,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56162,7 +61458,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56246,17 +61542,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56323,7 +61619,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56369,7 +61665,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56445,24 +61741,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56498,7 +61794,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56582,17 +61878,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56659,7 +61955,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56667,9 +61963,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -56679,8 +61975,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -56712,7 +62008,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56902,9 +62198,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56939,8 +62234,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -56990,9 +62285,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -57139,8 +62433,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -57351,24 +62645,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57404,7 +62698,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57488,17 +62782,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57565,7 +62859,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57573,9 +62867,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57585,8 +62879,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57618,7 +62912,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57694,24 +62988,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57747,7 +63041,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57831,17 +63125,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57908,7 +63202,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57916,9 +63210,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57928,8 +63222,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57961,7 +63255,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58151,9 +63445,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -58188,8 +63481,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -58239,9 +63532,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -58406,13 +63698,10 @@ export interface components { url: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request review_requested event */ - "webhook-pull-request-review-requested": OneOf< - [ - { + "webhook-pull-request-review-requested": + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -58623,24 +63912,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58676,7 +63965,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58760,17 +64049,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58837,7 +64126,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58845,9 +64134,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58857,8 +64146,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58890,7 +64179,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58966,24 +64255,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59019,7 +64308,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59103,17 +64392,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -59180,7 +64469,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59188,9 +64477,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -59200,8 +64489,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -59233,7 +64522,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59423,9 +64712,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -59460,8 +64748,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -59511,9 +64799,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -59660,8 +64947,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -59872,24 +65159,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59925,7 +65212,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60009,17 +65296,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60086,7 +65373,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60094,9 +65381,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60106,8 +65393,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60139,7 +65426,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60215,24 +65502,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60268,7 +65555,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60352,17 +65639,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60429,7 +65716,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60437,9 +65724,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -60449,8 +65736,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -60482,7 +65769,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60672,9 +65959,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -60709,8 +65995,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -60760,9 +66046,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -60927,9 +66212,7 @@ export interface components { url?: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { /** @enum {string} */ @@ -61139,24 +66422,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61192,7 +66475,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61276,17 +66559,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -61353,7 +66636,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61361,9 +66644,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -61373,8 +66656,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -61406,7 +66689,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61475,24 +66758,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61528,7 +66811,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61612,17 +66895,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -61689,7 +66972,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61697,9 +66980,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -61709,8 +66992,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -61742,7 +67025,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61887,9 +67170,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -61924,8 +67206,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -61975,9 +67257,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -62371,24 +67652,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62424,7 +67705,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62568,7 +67849,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62665,24 +67946,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62718,7 +67999,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62862,7 +68143,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63035,9 +68316,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -63072,8 +68352,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -63123,9 +68403,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -63591,24 +68870,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63644,7 +68923,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63788,7 +69067,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63885,24 +69164,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63938,7 +69217,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64082,7 +69361,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64255,9 +69534,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -64292,8 +69570,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -64343,9 +69621,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -64816,24 +70093,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64869,7 +70146,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64953,17 +70230,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65030,7 +70307,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65038,9 +70315,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65050,8 +70327,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65083,7 +70360,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65159,24 +70436,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65212,7 +70489,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65366,7 +70643,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65374,9 +70651,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65386,8 +70663,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65419,7 +70696,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65609,9 +70886,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -65646,8 +70922,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -65697,9 +70973,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -66059,24 +71334,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66112,7 +71387,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66196,17 +71471,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66273,7 +71548,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66281,9 +71556,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66293,8 +71568,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66326,7 +71601,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66402,24 +71677,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66455,7 +71730,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66539,17 +71814,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66616,7 +71891,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66624,9 +71899,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66636,8 +71911,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66669,7 +71944,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66859,9 +72134,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -66896,8 +72170,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -66947,9 +72221,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -67288,24 +72561,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67341,7 +72614,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67425,17 +72698,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -67502,7 +72775,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67510,9 +72783,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67522,8 +72795,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -67555,7 +72828,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -67631,24 +72904,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67684,7 +72957,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67838,7 +73111,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67846,9 +73119,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -67858,8 +73131,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -67891,7 +73164,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68081,9 +73354,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -68118,8 +73390,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -68169,9 +73441,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -68494,24 +73765,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68547,7 +73818,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68631,17 +73902,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -68708,7 +73979,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68716,9 +73987,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -68728,8 +73999,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -68761,7 +74032,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -68837,24 +74108,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68890,7 +74161,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68974,17 +74245,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -69051,7 +74322,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69059,9 +74330,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -69071,8 +74342,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -69104,7 +74375,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -69294,9 +74565,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -69331,8 +74601,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -69382,9 +74652,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -69639,24 +74908,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69692,7 +74961,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -69836,7 +75105,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69933,8 +75202,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -69958,19 +75227,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: string | Record | null; - bugs?: string | Record | null; + author?: (string | Record) | null; + bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: string | Record | null; + dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: string | Record | null; + repository?: (string | Record) | null; scripts?: Record; id?: string; node_version?: string; @@ -69983,7 +75252,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: string | Record | null; + directories?: (string | Record) | null; os?: string[]; cpu?: string[]; readme?: string; @@ -69995,21 +75264,18 @@ export interface components { } | null; nuget_metadata?: | { - id?: string | Record | number | null; + id?: (string | Record | number) | null; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -70206,7 +75472,7 @@ export interface components { updated_at: string; version: string; }; - registry: Record | null; + registry: Record; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -70843,7 +76109,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: (Record | null)[]; + assets?: Record[]; assets_url?: string; author?: { avatar_url?: string; @@ -71038,7 +76304,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: (Record | null)[]; + assets?: Record[]; assets_url?: string; author?: { avatar_url?: string; @@ -71387,7 +76653,7 @@ export interface components { /** Format: uri */ zipball_url: string | null; } & { - assets?: (Record | null)[]; + assets?: Record[]; assets_url?: string; author?: { avatar_url?: string; @@ -72808,24 +78074,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -72861,7 +78127,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -73000,7 +78266,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -73121,24 +78387,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -73174,7 +78440,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -73313,7 +78579,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -73434,24 +78700,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -73487,7 +78753,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -73626,7 +78892,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -73778,24 +79044,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -73831,7 +79097,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -73970,7 +79236,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -74091,24 +79357,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -74144,7 +79410,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -74283,7 +79549,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -74603,7 +79869,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: (Record | null)[]; + steps?: Record[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -75368,7 +80634,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: (Record | null)[]; + pull_requests?: Record[]; referenced_workflows?: | { path: string; @@ -76082,7 +81348,7 @@ export interface components { node_id?: string; path?: string; previous_attempt_url?: string | null; - pull_requests?: (Record | null)[]; + pull_requests?: Record[]; referenced_workflows?: | { path: string; @@ -76676,18 +81942,27 @@ export interface components { responses: { /** @description Resource not found */ not_found: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Bad Request */ bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -76695,34 +81970,52 @@ export interface components { }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ accepted: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description Not modified */ not_modified: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Requires authentication */ requires_authentication: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Service unavailable */ service_unavailable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -76733,6 +82026,9 @@ export interface components { }; /** @description Forbidden Gist */ forbidden_gist: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { block?: { @@ -76747,48 +82043,72 @@ export interface components { }; /** @description Conflict */ conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Gone */ gone: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Moved permanently */ moved_permanently: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Temporary Redirect */ temporary_redirect: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Internal Error */ internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Preview header missing */ preview_header_missing: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message: string; @@ -76798,22 +82118,28 @@ export interface components { }; /** @description Found */ found: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description A header with no content is returned. */ no_content: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; parameters: { /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "per-page"?: number; + "per-page": number; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: number; + page: number; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ - direction?: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The unique identifier of the key. */ "key-ids": string; /** @description The organization name. The name is not case sensitive. */ @@ -76825,10 +82151,10 @@ export interface components { /** @description The handle for the GitHub user account. */ username: string; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: string; + cursor: string; "delivery-id": number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: string; + since: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The client ID of the GitHub app. */ @@ -76840,65 +82166,61 @@ export interface components { /** @description The unique identifier of the organization. */ "org-id": number; /** @description Only return runner groups that are allowed to be used by this organization. */ - "visible-to-organization"?: string; + "visible-to-organization": string; /** @description Unique identifier of the self-hosted runner group. */ "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ "runner-id": number; /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ - "audit-log-phrase"?: string; + "audit-log-phrase": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ - "audit-log-after"?: string; + "audit-log-after": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ - "audit-log-before"?: string; - /** - * @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + "audit-log-before": string; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. * - * The default is `desc`. - */ - "audit-log-order"?: "desc" | "asc"; + * The default is `desc`. */ + "audit-log-order": "desc" | "asc"; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ - "secret-scanning-alert-secret-type"?: string; + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution"?: string; + "secret-scanning-alert-resolution": string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort"?: "created" | "updated"; + "secret-scanning-alert-sort": "created" | "updated"; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; + "pagination-before": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; + "pagination-after": string; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ - "secret-scanning-alert-validity"?: string; + "secret-scanning-alert-validity": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: string; + labels: string; /** @description If `true`, show notifications marked as read. */ - all?: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: string; + before: string; /** @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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org"?: number; + "since-org": number; /** @description The unique identifier of the repository. */ "repository-id": number; /** @description The name of the secret. */ "secret-name": string; /** @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. */ - "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @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. */ - "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description The unique identifier of the group. */ "group-id": number; /** @description The unique identifier of the migration. */ @@ -76928,13 +82250,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch"?: string; + "workflow-run-branch": string; /** @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/github-ae@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - event?: string; + event: string; /** @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`. */ - "workflow-run-status"?: + "workflow-run-status": | "completed" | "action_required" | "cancelled" @@ -76950,17 +82272,17 @@ export interface components { | "waiting" | "pending"; /** @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/github-ae@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - created?: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests"?: boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id"?: number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha"?: string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - "artifact-name"?: string; + "artifact-name": string; /** @description The attempt number of the workflow run. */ "attempt-number": number; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ @@ -76974,11 +82296,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name"?: string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - status?: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @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`. */ - "git-ref"?: components["schemas"]["code-scanning-ref"]; + "git-ref": components["schemas"]["code-scanning-ref"]; /** @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. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -76994,7 +82316,7 @@ export interface components { /** @description The unique identifier of the invitation. */ "invitation-id": number; /** @description The property to sort the results by. */ - sort?: "created" | "updated"; + sort: "created" | "updated"; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -77010,19 +82332,19 @@ export interface components { /** @description The unique identifier of the release. */ "release-id": number; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: "desc" | "asc"; + order: "desc" | "asc"; /** @description The unique identifier of the team. */ "team-id": number; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "since-repo-date"?: string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date"?: string; + "before-repo-date": string; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred"?: "created" | "updated"; + "sort-starred": "created" | "updated"; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user"?: number; + "since-user": number; }; requestBodies: never; headers: { @@ -77043,39 +82365,47 @@ export interface components { }; pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - /** - * GitHub API Root - * @description Get Hypermedia links to resources accessible in GitHub's REST API - */ "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["root"]; }; }; }; }; - /** List global webhooks */ "enterprise-admin/list-global-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["global-hook"][]; @@ -77083,8 +82413,13 @@ export interface operations { }; }; }; - /** Create a global webhook */ "enterprise-admin/create-global-webhook": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -77114,51 +82449,68 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Get a global webhook */ "enterprise-admin/get-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook"]; }; }; }; }; - /** Delete a global webhook */ "enterprise-admin/delete-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a global webhook - * @description Parameters that are not provided will be overwritten with the default value or removed if no default exists. - */ "enterprise-admin/update-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -77187,46 +82539,60 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-hook-2"]; }; }; }; }; - /** - * Ping a global webhook - * @description This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the webhook. - */ "enterprise-admin/ping-global-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List public keys */ "enterprise-admin/list-public-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "accessed"; /** @description Only show public keys accessed after the given time. */ since?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["public-key-full"][]; @@ -77234,22 +82600,34 @@ export interface operations { }; }; }; - /** Delete a public key */ "enterprise-admin/delete-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_ids: components["parameters"]["key-ids"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Create an organization */ "enterprise-admin/create-org": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -77265,18 +82643,24 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-simple"]; }; }; }; }; - /** Update an organization name */ "enterprise-admin/update-org-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -77289,6 +82673,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -77298,27 +82685,41 @@ export interface operations { }; }; }; - /** List pre-receive environments */ "enterprise-admin/list-pre-receive-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; sort?: "created" | "updated" | "name"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"][]; }; }; }; }; - /** Create a pre-receive environment */ "enterprise-admin/create-pre-receive-environment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -77332,51 +82733,62 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** Get a pre-receive environment */ "enterprise-admin/get-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; }; }; - /** - * Delete a pre-receive environment - * @description If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Cannot delete environment that has hooks_ - * * _Cannot delete environment when download is in progress_ - */ "enterprise-admin/delete-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -77390,15 +82802,15 @@ export interface operations { }; }; }; - /** - * Update a pre-receive environment - * @description You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response. - */ "enterprise-admin/update-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -77413,12 +82825,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -77432,32 +82850,32 @@ export interface operations { }; }; }; - /** - * Start a pre-receive environment download - * @description Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. - * - * If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. - * - * The possible error messages are: - * - * * _Cannot modify or delete the default environment_ - * * _Can not start a new download when a download is in progress_ - */ "enterprise-admin/start-pre-receive-environment-download": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; /** @description Client Errors */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -77471,41 +82889,48 @@ export interface operations { }; }; }; - /** - * Get the download status for a pre-receive environment - * @description In addition to seeing the download status at the "[Get a pre-receive environment](#get-a-pre-receive-environment)" endpoint, there is also this separate endpoint for just the download status. - */ "enterprise-admin/get-download-status-for-pre-receive-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the pre-receive environment. */ pre_receive_environment_id: components["parameters"]["pre-receive-environment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pre-receive-environment-download-status"]; }; }; }; }; - /** - * List personal access tokens - * @description Lists personal access tokens for all users, including admin users. - */ "enterprise-admin/list-personal-access-tokens": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["authorization"][]; @@ -77513,48 +82938,57 @@ export interface operations { }; }; }; - /** - * Delete a personal access token - * @description Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error. - */ "enterprise-admin/delete-personal-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the token. */ token_id: components["parameters"]["token-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a user - * @description Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/github-ae@latest/rest/enterprise-admin/users#suspend-a-user) is often a better option. - * - * You can delete any user account except your own. - */ "enterprise-admin/delete-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Create an impersonation OAuth token */ "enterprise-admin/create-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody: { content: { @@ -77567,61 +83001,81 @@ export interface operations { responses: { /** @description Response when getting an existing impersonation OAuth token */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; /** @description Response when creating a new impersonation OAuth token */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; }; }; - /** Delete an impersonation OAuth token */ "enterprise-admin/delete-impersonation-o-auth-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/github-ae@latest/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; }; }; }; - /** - * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/github-ae@latest/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ "apps/create-from-manifest": { parameters: { + query?: never; + header?: never; path: { code: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"] & { client_id: string; @@ -77636,29 +83090,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a webhook configuration for an app - * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an app - * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -77672,29 +83130,35 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an app webhook - * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -77703,21 +83167,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for an app webhook - * @description Returns a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -77726,38 +83191,41 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an app webhook - * @description Redeliver a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List installation requests for the authenticated app - * @description Lists all the pending installation requests for the authenticated GitHub App. - */ "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of integration installation requests */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration-installation-request"][]; }; @@ -77766,26 +83234,28 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List installations for the authenticated app - * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * The permissions the installation has are included under the `permissions` key. - */ "apps/list-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; outdated?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description The permissions the installation has are included under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -77933,11 +83403,11 @@ export interface operations { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ permissions: { /** @@ -78120,12 +83590,10 @@ export interface operations { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -78207,21 +83675,23 @@ export interface operations { }; }; }; - /** - * Get an installation for the authenticated app - * @description Enables an authenticated GitHub App to find an installation's information using the installation id. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -78229,37 +83699,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/github-ae@latest/rest/apps/apps#suspend-an-app-installation)" endpoint. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/delete-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/create-installation-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -78269,8 +83739,8 @@ export interface operations { /** * @description List of repository IDs that the token should have access to * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -78280,6 +83750,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation-token"]; }; @@ -78290,56 +83763,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub AE API or webhook events is blocked for that account. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/suspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unsuspend an app installation - * @description Removes a GitHub App installation suspension. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/unsuspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "apps/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78352,20 +83828,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. - */ "apps/check-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78378,6 +83857,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -78386,15 +83868,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. - */ "apps/delete-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78407,20 +83889,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ "apps/reset-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -78433,6 +83918,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -78440,44 +83928,46 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Reset an authorization - * @deprecated - * @description **Deprecation Notice:** GitHub AE will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/). - * - * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ "apps/reset-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; access_token: components["parameters"]["access-token"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; }; }; }; - /** - * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) of the target app to access this endpoint. - */ "apps/get-by-slug": { parameters: { + query?: never; + header?: never; path: { app_slug: components["parameters"]["app-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; @@ -78486,14 +83976,20 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get all codes of conduct - * @description Returns array of all GitHub's codes of conduct. - */ "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"][]; }; @@ -78501,19 +83997,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a code of conduct - * @description Returns information about the specified GitHub code of conduct. - */ "codes-of-conduct/get-conduct-code": { parameters: { + query?: never; + header?: never; path: { key: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"]; }; @@ -78522,54 +84021,74 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get emojis - * @description Lists all the emojis available to use on GitHub AE. - */ "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { - [key: string]: string; + [key: string]: string | undefined; }; }; }; 304: components["responses"]["not_modified"]; }; }; - /** - * Get the global announcement banner - * @description Gets the current message and expiration date of the global announcement banner in your enterprise. - */ "enterprise-admin/get-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** - * Remove the global announcement banner - * @description Removes the global announcement banner in your enterprise. - */ "enterprise-admin/remove-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set the global announcement banner - * @description Sets the message and expiration time for the global announcement banner in your enterprise. - */ "enterprise-admin/set-announcement": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["announcement"]; @@ -78578,176 +84097,287 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["announcement"]; }; }; }; }; - /** Get license information */ "enterprise-admin/get-license-information": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-info"]; }; }; }; }; - /** Get all statistics */ "enterprise-admin/get-all-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-overview"]; }; }; }; }; - /** Get comment statistics */ "enterprise-admin/get-comment-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-comment-overview"]; }; }; }; }; - /** Get gist statistics */ "enterprise-admin/get-gist-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-gist-overview"]; }; }; }; }; - /** Get hooks statistics */ "enterprise-admin/get-hooks-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-hook-overview"]; }; }; }; }; - /** Get issue statistics */ "enterprise-admin/get-issue-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-issue-overview"]; }; }; }; }; - /** Get milestone statistics */ "enterprise-admin/get-milestone-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-milestone-overview"]; }; }; }; }; - /** Get organization statistics */ "enterprise-admin/get-org-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-organization-overview"]; }; }; }; }; - /** Get pages statistics */ "enterprise-admin/get-pages-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-page-overview"]; }; }; }; }; - /** Get pull request statistics */ "enterprise-admin/get-pull-request-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-pull-request-overview"]; }; }; }; }; - /** Get repository statistics */ "enterprise-admin/get-repo-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-repository-overview"]; }; }; }; }; - /** Get users statistics */ "enterprise-admin/get-user-stats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["enterprise-user-overview"]; }; }; }; }; - /** - * Get GitHub Actions permissions for an enterprise - * @description Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-enterprise-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an enterprise - * @description Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-github-actions-permissions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78760,29 +84390,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -78792,17 +84428,15 @@ export interface operations { }; }; }; - /** - * Set selected organizations enabled for GitHub Actions in an enterprise - * @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)." - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78815,82 +84449,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected organization for GitHub Actions in an enterprise - * @description Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/enable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected organization for GitHub Actions in an enterprise - * @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)." - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/disable-selected-organization-github-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description The unique identifier of the organization. */ org_id: components["parameters"]["org-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an enterprise - * @description Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an enterprise - * @description Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-allowed-actions-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78900,30 +84543,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an enterprise - * @description Lists all self-hosted runner groups for an enterprise. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runner-groups-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only return runner groups that are allowed to be used by this organization. */ visible_to_organization?: components["parameters"]["visible-to-organization"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -78933,17 +84583,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an enterprise - * @description Creates a new self-hosted runner group for an enterprise. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/create-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; requestBody: { content: { @@ -78970,66 +84618,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Get a self-hosted runner group for an enterprise - * @description Gets a specific self-hosted runner group for an enterprise. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an enterprise - * @description Deletes a self-hosted runner group for an enterprise. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-group-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an enterprise - * @description Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/update-self-hosted-runner-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -79053,34 +84709,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-enterprise"]; }; }; }; }; - /** - * List self-hosted runners in a group for an enterprise - * @description Lists the self-hosted runners that are in a specific enterprise group. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79091,18 +84752,17 @@ export interface operations { }; }; }; - /** - * Set self-hosted runners in a group for an enterprise - * @description Replaces the list of self-hosted runners that are part of an enterprise runner group. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79115,74 +84775,85 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add a self-hosted runner to a group for an enterprise - * @description Adds a self-hosted runner to a runner group configured in an enterprise. - * - * You must authenticate using an access token with the `manage_runners:enterprise` - * scope to use this endpoint. - */ "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a self-hosted runner from a group for an enterprise - * @description Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. - * - * You must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint. - */ "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an enterprise - * @description Lists all self-hosted runners configured for an enterprise. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-self-hosted-runners-for-enterprise": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79193,182 +84864,199 @@ export interface operations { }; }; }; - /** - * List runner applications for an enterprise - * @description Lists binaries for the runner application that you can download and run. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/list-runner-applications-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create a registration token for an enterprise - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. - * - * ``` - * ./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN - * ``` - */ "enterprise-admin/create-registration-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an enterprise - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - * - * Example using remove token: - * - * To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this - * endpoint. - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - */ "enterprise-admin/create-remove-token-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an enterprise - * @description Gets a specific self-hosted runner configured in an enterprise. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/get-self-hosted-runner-for-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an enterprise - * @description Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. - */ "enterprise-admin/delete-self-hosted-runner-from-enterprise": { parameters: { + query?: never; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the audit log for an enterprise - * @description Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the `admin:enterprise` scope. - */ "enterprise-admin/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-phrase"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List secret scanning alerts for an enterprise - * @description 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/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - */ "secret-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -79378,47 +85066,47 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get feeds - * @description GitHub AE provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: - * - * * **Timeline**: The GitHub AE global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub AE. - * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. - */ "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["feed"]; }; }; }; }; - /** - * List gists for the authenticated user - * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: - */ "gists/list": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -79428,13 +85116,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a gist - * @description Allows you to add a new gist with one or more files. - * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - */ "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -79446,16 +85134,18 @@ export interface operations { /** * @description Names and content for the files that make up the gist * @example { - * "hello.rb": { - * "content": "puts \"Hello, World!\"" - * } - * } + * "hello.rb": { + * "content": "puts \"Hello, World!\"" + * } + * } */ files: { - [key: string]: { - /** @description Content of the file */ - content: string; - }; + [key: string]: + | { + /** @description Content of the file */ + content: string; + } + | undefined; }; public?: boolean | ("true" | "false"); }; @@ -79467,6 +85157,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"]; @@ -79478,25 +85169,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List public gists - * @description List public gists sorted by most recently updated to least recently updated. - * - * Note: With [pagination](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - */ "gists/list-public": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -79507,23 +85200,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List starred gists - * @description List the authenticated user's starred gists: - */ "gists/list-starred": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -79534,24 +85231,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a gist - * @description Gets a specified gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -79561,32 +85257,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist */ "gists/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist - * @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. - */ "gists/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79598,23 +85301,25 @@ export interface operations { description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. + * (including extension) of the targeted gist file. For example: `hello.py`. * - * To delete a file, set the whole file to null. For example: `hello.py : null`. + * To delete a file, set the whole file to null. For example: `hello.py : null`. * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } */ files?: { - [key: string]: { - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - }; + [key: string]: + | { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + } + | undefined; }; } | null; }; @@ -79622,6 +85327,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -79630,30 +85338,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List gist comments - * @description Lists the comments on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/list-comments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"][]; @@ -79664,20 +85370,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a gist comment - * @description Creates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79696,6 +85397,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"]; @@ -79706,25 +85408,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist comment - * @description Gets a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -79734,39 +85436,43 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist comment */ "gists/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist comment - * @description Updates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -79782,6 +85488,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -79789,23 +85498,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist commits */ "gists/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-commit"][]; @@ -79816,22 +85531,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist forks */ "gists/list-forks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"][]; @@ -79842,19 +85563,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Fork a gist */ "gists/fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"]; @@ -79866,84 +85592,104 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Check if a gist is starred */ "gists/check-is-starred": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if gist is starred */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; }; }; - /** - * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "gists/star": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** Unstar a gist */ "gists/unstar": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist revision - * @description Gets a specified gist revision. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-revision": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -79953,14 +85699,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/github-ae@latest/rest/repos/repos#create-a-repository-for-the-authenticated-user). - */ "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -79968,23 +85720,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a gitignore template - * @description Get the content of a gitignore template. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. - */ "gitignore/get-template": { parameters: { + query?: never; + header?: never; path: { name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gitignore-template"]; }; @@ -79992,24 +85743,25 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * List repositories accessible to the app installation - * @description List repositories that an app installation can access. - * - * You must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - */ "apps/list-repos-accessible-to-installation": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -80025,40 +85777,24 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Revoke an installation access token - * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. - * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/github-ae@latest/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - * - * You must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - */ "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List issues assigned to the authenticated user - * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list": { parameters: { query?: { @@ -80072,24 +85808,34 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; collab?: boolean; orgs?: boolean; owned?: boolean; pulls?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -80100,21 +85846,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get-all-commonly-used": { parameters: { query?: { featured?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-simple"][]; }; @@ -80122,19 +85873,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get": { parameters: { + query?: never; + header?: never; path: { license: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license"]; }; @@ -80144,8 +85898,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Render a Markdown document */ "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -80171,6 +85930,7 @@ export interface operations { /** @example 279 */ "Content-Length"?: string; "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -80179,11 +85939,13 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Render a Markdown document in raw mode - * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - */ "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "text/plain": string; @@ -80195,6 +85957,7 @@ export interface operations { 200: { headers: { "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -80203,20 +85966,20 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get GitHub AE meta information - * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/github-ae@latest/articles/about-github-s-ip-addresses/)." - * - * The API's response also includes a list of GitHub's domain names. - * - * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. - * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. - */ "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["api-overview"]; }; @@ -80224,27 +85987,33 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * List notifications for the authenticated user - * @description List all notifications for the current user, sorted by most recently updated. - */ "activity/list-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -80256,11 +86025,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE 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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -80277,6 +86048,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -80285,26 +86059,33 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread - * @description Gets information about a notification thread. - */ "activity/get-thread": { parameters: { + query?: never; + header?: never; path: { + /** @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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread"]; }; @@ -80314,57 +86095,67 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Mark a thread as done - * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub AE as done: https://github.com/notifications. - */ "activity/mark-thread-as-done": { parameters: { + query?: never; + header?: never; path: { + /** @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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Mark a thread as read - * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub AE: https://github.com/notifications. - */ "activity/mark-thread-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/github-ae@latest/rest/activity/watching#get-a-repository-subscription). - * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - */ "activity/get-thread-subscription-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -80374,19 +86165,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Set a thread subscription - * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. - * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/github-ae@latest/rest/activity/notifications#delete-a-thread-subscription) endpoint. - */ "activity/set-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80402,6 +86189,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -80411,65 +86201,73 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/github-ae@latest/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. - */ "activity/delete-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @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/github-ae@latest/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get Octocat - * @description Get the octocat as ASCII art - */ "meta/get-octocat": { parameters: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/octocat-stream": string; }; }; }; }; - /** - * List organizations - * @description Lists all organizations, in the order that they were created on GitHub AE. - * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. - */ "orgs/list": { parameters: { query?: { + /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -80478,21 +86276,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get an organization - * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/github-ae@latest/articles/securing-your-account-with-two-factor-authentication-2fa/). - * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See "[Authenticating with GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub AE plan information' below." - */ "orgs/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -80500,17 +86300,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization - * @description **Parameter Deprecation Notice:** GitHub AE 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). - * - * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. - */ "orgs/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80552,7 +86350,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -80583,53 +86381,41 @@ export interface operations { web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ blog?: string; - /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + /** @description Whether Dependabot alerts is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + /** @description Whether Dependabot security updates is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** - * @description Whether dependency graph is automatically enabled for new repositories. + /** @description Whether dependency graph is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning is automatically enabled for new repositories. + /** @description Whether secret scanning is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + /** @description Whether secret scanning push protection is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether secret scanning automatic validity checks on supported partner tokens is enabled for all repositories under this organization. */ secret_scanning_validity_checks_enabled?: boolean; @@ -80639,6 +86425,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -80646,6 +86435,9 @@ export interface operations { 409: components["responses"]["conflict"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -80654,40 +86446,38 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions permissions for an organization - * @description Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-organization-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an organization - * @description Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization. - * - * If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/set-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80700,29 +86490,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80732,17 +86528,15 @@ export interface operations { }; }; }; - /** - * Set selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/set-selected-repositories-enabled-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80755,86 +86549,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected repository for GitHub Actions in an organization - * @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)." - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/enable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected repository for GitHub Actions in an organization - * @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)." - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/disable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for an organization - * @description Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for an organization - * @description Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - * - * If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. - * - * To 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. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/set-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80844,46 +86643,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an organization - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/github-ae@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an organization - * @description 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 - * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/github-ae@latest/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. - */ "actions/set-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80893,28 +86691,35 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runner groups for an organization - * @description Lists all self-hosted runner groups configured in an organization and inherited from an enterprise. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ "actions/list-self-hosted-runner-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -80924,17 +86729,15 @@ export interface operations { }; }; }; - /** - * Create a self-hosted runner group for an organization - * @description Creates a new self-hosted runner group for an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ "actions/create-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -80969,66 +86772,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Get a self-hosted runner group for an organization - * @description Gets a specific self-hosted runner group for an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ "actions/get-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Delete a self-hosted runner group from an organization - * @description Deletes a self-hosted runner group for an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-group-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a self-hosted runner group for an organization - * @description Updates the `name` and `visibility` of a self-hosted runner group in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - */ "actions/update-self-hosted-runner-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81058,58 +86869,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - /** - * Add a self-hosted runner to a group for an organization - * @description Adds a self-hosted runner to a runner group configured in an organization. - * - * You must authenticate using an access token with the `admin:org` - * scope to use this endpoint. - */ "actions/add-self-hosted-runner-to-group-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner group. */ runner_group_id: components["parameters"]["runner-group-id"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an organization - * @description Lists all self-hosted runners configured in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/list-self-hosted-runners-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81120,168 +86935,145 @@ export interface operations { }; }; }; - /** - * List runner applications for an organization - * @description Lists binaries for the runner application that you can download and run. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/list-runner-applications-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create a registration token for an organization - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - */ "actions/create-registration-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an organization - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using remove token: - * - * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - * endpoint. - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - */ "actions/create-remove-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an organization - * @description Gets a specific self-hosted runner configured in an organization. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/get-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an organization - * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/delete-self-hosted-runner-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization 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. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81292,72 +87084,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/github-ae@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81379,63 +87164,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @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. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @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. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -81445,23 +87236,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -81474,120 +87259,129 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/github-ae@latest/rest/actions/secrets#create-or-update-an-organization-secret). - * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the audit log for an organization - * @description Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." - * - * This endpoint is available for organizations on GitHub Enterprise Cloud. To use this endpoint, you must be an organization owner, and you must use an access token with the `admin:org` scope. GitHub Apps must have the `organization_administration` read permission to use this endpoint. - * - * By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/github-ae@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." - * - * Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api)." - */ "orgs/get-audit-log": { parameters: { query?: { + /** @description A search phrase. For more information, see [Searching the audit log](https://docs.github.com/github-ae@latest/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). */ phrase?: components["parameters"]["audit-log-phrase"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. */ after?: components["parameters"]["audit-log-after"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. */ before?: components["parameters"]["audit-log-before"]; + /** @description The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + * + * The default is `desc`. */ order?: components["parameters"]["audit-log-order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["audit-log-event"][]; }; }; }; }; - /** - * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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. - */ "code-scanning/list-alerts-for-org": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; @@ -81596,15 +87390,20 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -81614,53 +87413,56 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get an external group - * @description Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/external-idp-group-info-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the group. */ group_id: components["parameters"]["group-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List external groups in an organization - * @description Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub AE generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/list-external-idp-groups-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description Page token */ page?: number; /** @description Limits the list to groups containing the text in the group name */ display_name?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["external-groups"]; @@ -81668,22 +87470,28 @@ export interface operations { }; }; }; - /** List organization webhooks */ "orgs/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"][]; @@ -81692,15 +87500,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization webhook - * @description Here's how you can create a hook that posts payloads in JSON format: - */ "orgs/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -81721,8 +87529,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -81739,6 +87547,7 @@ export interface operations { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"]; @@ -81748,20 +87557,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." - */ "orgs/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -81769,32 +87583,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete an organization webhook */ "orgs/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." - */ "orgs/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -81809,8 +87632,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -81826,6 +87649,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -81834,40 +87660,42 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for an organization - * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. - */ "orgs/get-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an organization - * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. - */ "orgs/update-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -81882,31 +87710,40 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an organization webhook - * @description Returns a list of webhook deliveries for a webhook configured in an organization. - */ "orgs/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -81915,21 +87752,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook delivery for an organization webhook - * @description Returns a delivery for a webhook configured in an organization. - */ "orgs/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -81938,83 +87780,95 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an organization webhook - * @description Redeliver a delivery for a webhook configured in an organization. - */ "orgs/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. - */ "orgs/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an organization installation for the authenticated app - * @description Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-org-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. - */ "orgs/list-app-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -82025,22 +87879,6 @@ export interface operations { }; }; }; - /** - * List organization issues assigned to the authenticated user - * @description List issues in an organization assigned to the authenticated user. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-org": { parameters: { query?: { @@ -82054,23 +87892,33 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -82079,10 +87927,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization members - * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. - */ "orgs/list-members": { parameters: { query?: { @@ -82090,18 +87934,25 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -82110,69 +87961,88 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Check organization membership for a user - * @description Check if a user is, publicly or privately, a member of the organization. - */ "orgs/check-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if requester is an organization member and user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if requester is not an organization member */ 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization member - * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - */ "orgs/remove-member": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get organization membership for a user - * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. - */ "orgs/get-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -82181,32 +88051,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set organization membership for a user - * @description Only authenticated organization owners can add a member to the organization or update the member's role. - * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/github-ae@latest/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. - * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. - * - * **Rate limits** - * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. - */ "orgs/set-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. * @default member * @enum {string} */ @@ -82217,6 +88080,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -82225,51 +88091,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove organization membership for a user - * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - */ "orgs/remove-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List organization migrations - * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). - * - * A list of `repositories` is only returned for export migrations. - */ "migrations/list-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -82277,15 +88147,15 @@ export interface operations { }; }; }; - /** - * Start an organization migration - * @description Initiates the generation of a migration archive. - */ "migrations/start-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82340,6 +88210,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -82348,36 +88221,31 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization migration status - * @description Fetches the status of a migration. - * - * The `state` of a migration can be one of the following values: - * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ "migrations/get-status-for-org": { parameters: { query?: { /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** - * @description * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -82385,84 +88253,104 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download an organization migration archive - * @description Fetches the URL to a migration archive. - */ "migrations/download-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization migration archive - * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. - */ "migrations/delete-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/github-ae@latest/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. - */ "migrations/unlock-repo-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List repositories in an organization migration - * @description List all the repositories for this organization migration. - */ "migrations/list-repos-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -82471,27 +88359,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List outside collaborators for an organization - * @description List all users who are outside collaborators of an organization. - */ "orgs/list-outside-collaborators": { parameters: { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -82499,16 +88390,17 @@ export interface operations { }; }; }; - /** - * Convert an organization member to outside collaborator - * @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/github-ae@latest/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/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." - */ "orgs/convert-member-to-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82524,39 +88416,56 @@ export interface operations { responses: { /** @description User is getting converted asynchronously */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description User was converted */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @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/github-ae@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Remove outside collaborator from an organization - * @description Removing a user from this list will remove them from all the organization's repositories. - */ "orgs/remove-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -82566,27 +88475,30 @@ export interface operations { }; }; }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-org": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -82595,15 +88507,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82618,6 +88530,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -82629,12 +88544,6 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization repositories - * @description 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/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/list-for-org": { parameters: { query?: { @@ -82644,18 +88553,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -82663,22 +88579,15 @@ export interface operations { }; }; }; - /** - * Create an organization repository - * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository - */ "repos/create-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82696,7 +88605,7 @@ export interface operations { private?: boolean; /** * @description The visibility of the repository. **Note**: For 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/github-ae@latest/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)" in the GitHub Help documentation. - * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. + * The `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header. * @enum {string} */ visibility?: "public" | "private" | "internal"; @@ -82765,26 +88674,26 @@ export interface operations { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -82797,6 +88706,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -82806,25 +88716,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List teams - * @description Lists all teams in an organization that are visible to the authenticated user. - */ "teams/list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -82833,17 +88746,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a team - * @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/github-ae@latest/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-ae@latest/github/setting-up-and-managing-organizations-and-teams/about-teams)". - */ "teams/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82858,21 +88769,21 @@ export interface operations { repo_names?: string[]; /** * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` * @enum {string} */ notification_setting?: @@ -82892,6 +88803,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -82900,22 +88814,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a team by name - * @description Gets a team using the team's `slug`. To create the `slug`, GitHub AE replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. - */ "teams/get-by-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -82923,40 +88840,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team - * @description To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - */ "teams/delete-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a team - * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - */ "teams/update-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82967,18 +88884,18 @@ export interface operations { description?: string; /** * @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: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -82998,12 +88915,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -83013,31 +88936,34 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions - * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - */ "teams/list-discussions-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Pinned discussions only filter */ pinned?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -83045,20 +88971,17 @@ export interface operations { }; }; }; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - */ "teams/create-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -83078,69 +89001,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - */ "teams/get-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - */ "teams/delete-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - */ "teams/update-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83155,36 +89089,43 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments - * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - */ "teams/list-discussion-comments-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -83192,21 +89133,19 @@ export interface operations { }; }; }; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * **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`. - */ "teams/create-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83219,72 +89158,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - */ "teams/get-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - */ "teams/delete-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - */ "teams/update-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83297,18 +89250,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { @@ -83322,21 +89272,31 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -83344,20 +89304,21 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - */ "reactions/create-for-team-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83381,47 +89342,53 @@ export interface operations { responses: { /** @description Response when the reaction type has already been added to this team discussion comment */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "reactions/delete-for-team-discussion-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { @@ -83435,20 +89402,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -83456,19 +89432,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - */ "reactions/create-for-team-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -83492,72 +89468,85 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "reactions/delete-for-team-discussion": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove the connection between an external group and a team - * @description Deletes a connection between a team and an external group. - * - * You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "teams/unlink-external-idp-group-from-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update the connection between an external group and a team - * @description Creates a connection between a team and an external group. Only one external group can be linked to a team. - * - * You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. - */ "teams/link-external-idp-group-to-team-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -83573,36 +89562,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["external-group"]; }; }; }; }; - /** - * List team members - * @description Team members will include the members of child teams. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/list-members-in-org": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -83610,61 +89604,53 @@ export interface operations { }; }; }; - /** - * Get team membership for a user - * @description Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/teams/teams#create-a-team). - */ "teams/get-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ 404: { - content: never; - }; - }; - }; - /** - * Add or update team membership for a user - * @description 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/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. - * - * If 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. - * - * **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}`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-or-update-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83681,71 +89667,85 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user - * @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. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/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}`. - */ "teams/remove-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ "teams/list-projects-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -83753,46 +89753,53 @@ export interface operations { }; }; }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/check-permissions-for-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/add-or-update-project-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83808,10 +89815,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -83821,49 +89834,55 @@ export interface operations { }; }; }; - /** - * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/remove-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team repositories - * @description Lists a team's repositories visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - */ "teams/list-repos-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -83871,60 +89890,64 @@ export interface operations { }; }; }; - /** - * Check team permissions for a repository - * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. - * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/check-permissions-for-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with repository permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team does not have permission for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions - * @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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **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-ae@latest/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". - */ "teams/add-or-update-repo-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -83940,54 +89963,64 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a repository from a team - * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/remove-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams - * @description Lists the child teams of the team specified by `{team_slug}`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - */ "teams/list-child-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -83995,19 +90028,23 @@ export interface operations { }; }; }; - /** - * Get a project card - * @description Gets information about a project card. - */ "projects/get-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -84018,25 +90055,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project card - * @description Deletes a project card - */ "projects/delete-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84048,12 +90092,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ "projects/update-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84074,6 +90121,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -84085,12 +90135,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ "projects/move-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84111,6 +90164,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -84119,6 +90175,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84135,6 +90194,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -84149,19 +90211,23 @@ export interface operations { }; }; }; - /** - * Get a project column - * @description Gets information about a project column. - */ "projects/get-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -84172,32 +90238,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project column - * @description Deletes a project column. - */ "projects/delete-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ "projects/update-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84213,6 +90286,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -84222,27 +90298,30 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List project cards - * @description Lists the project cards in a project. - */ "projects/list-cards": { parameters: { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-card"][]; @@ -84253,25 +90332,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ "projects/create-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** * @description The project card's note * @example Update all gems */ note: string | null; - }, - { + } + | { /** * @description The unique identifier of the content associated with the card * @example 42 @@ -84282,14 +90363,15 @@ export interface operations { * @example PullRequest */ content_type: string; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -84299,6 +90381,9 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -84307,6 +90392,9 @@ export interface operations { }; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -84321,12 +90409,15 @@ export interface operations { }; }; }; - /** Move a project column */ "projects/move-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84342,6 +90433,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -84352,19 +90446,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -84374,25 +90472,32 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ "projects/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Delete Success */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84405,15 +90510,15 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84446,6 +90551,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -84454,6 +90562,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84464,33 +90575,39 @@ export interface operations { }; /** @description Not Found if the authenticated user does not have access to the project */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 410: components["responses"]["gone"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ "projects/list-collaborators": { parameters: { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -84503,16 +90620,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ "projects/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84530,7 +90648,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -84539,21 +90660,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ "projects/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -84562,20 +90688,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ "projects/get-permission-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-collaborator-permission"]; }; @@ -84587,25 +90718,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List project columns - * @description Lists the project columns in a project. - */ "projects/list-columns": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-column"][]; @@ -84616,15 +90750,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a project column - * @description Creates a new project column. - */ "projects/create-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -84640,6 +90774,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -84650,24 +90787,14 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. - * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/github-ae@latest/rest/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/github-ae@latest/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/github-ae@latest/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/github-ae@latest/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/github-ae@latest/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/github-ae@latest/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/github-ae@latest/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/github-ae@latest/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - */ "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -84675,6 +90802,7 @@ export interface operations { "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["rate-limit-overview"]; @@ -84684,22 +90812,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository - * @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. - * - * **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/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - */ "repos/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -84709,28 +90840,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a repository - * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. - * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. - */ "repos/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -84741,16 +90877,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/github-ae@latest/rest/repos/repos#replace-all-repository-topics) endpoint. - */ "repos/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -84763,7 +90900,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/github-ae@latest/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/github-ae@latest/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -84772,16 +90909,14 @@ export interface operations { * @enum {string} */ visibility?: "public" | "private" | "internal"; - /** - * @description Specify which security and analysis features to enable or disable for the repository. + /** @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/github-ae@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. * - * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { @@ -84859,26 +90994,26 @@ export interface operations { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -84903,6 +91038,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -84913,26 +91051,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List artifacts for 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. - */ "actions/list-artifacts-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -84943,146 +91085,164 @@ export interface operations { }; }; }; - /** - * Get an artifact - * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. - */ "actions/get-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["artifact"]; }; }; }; }; - /** - * Delete an artifact - * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. - */ "actions/delete-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download an artifact - * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. - */ "actions/download-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; archive_format: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { Location: components["headers"]["location"]; + [name: string]: unknown; }; - content: never; + content?: never; }; 410: components["responses"]["gone"]; }; }; - /** - * Get a job for a workflow run - * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. - */ "actions/get-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["job"]; }; }; }; }; - /** - * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. 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. - */ "actions/download-job-logs-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * List repository organization secrets - * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/list-repo-organization-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85093,43 +91253,42 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions permissions for a repository - * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository. - * - * You 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. - */ "actions/get-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-repository-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for a repository - * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository. - * - * If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository. - * - * You 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. - */ "actions/set-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -85142,48 +91301,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions for a repository - * @description Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * You 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. - */ "actions/get-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions for a repository - * @description Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. - * - * To 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. - * - * You 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. - */ "actions/set-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85193,34 +91353,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for a repository - * @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. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85231,172 +91394,173 @@ export interface operations { }; }; }; - /** - * List runner applications for a repository - * @description Lists binaries for the runner application that you can download and run. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/list-runner-applications-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token - * expires after one hour. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - * by this endpoint. - * - * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` - */ "actions/create-registration-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for a repository - * @description Returns a token that you can pass to remove a self-hosted runner from - * a repository. The token expires after one hour. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using remove token: - * - * To remove your self-hosted runner from a repository, replace TOKEN with - * the remove token provided by this endpoint. - * - * ```config.sh remove --token TOKEN``` - */ "actions/create-remove-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for a repository - * @description Gets a specific self-hosted runner configured in a repository. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/get-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from a repository - * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - */ "actions/delete-self-hosted-runner-from-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow runs for a repository - * @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/github-ae@latest/rest/guides/getting-started-with-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. GitHub Apps must have the `actions:read` permission to use this endpoint. - */ "actions/list-workflow-runs-for-repo": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/github-ae@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/github-ae@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85407,73 +91571,89 @@ export interface operations { }; }; }; - /** - * Get a workflow run - * @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. - */ "actions/get-workflow-run": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * Delete a workflow run - * @description Delete a specific workflow run. Anyone with write 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:write` permission to use - * this endpoint. - */ "actions/delete-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow run artifacts - * @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. - */ "actions/list-workflow-run-artifacts": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85484,56 +91664,66 @@ export interface operations { }; }; }; - /** - * Get a workflow run attempt - * @description Gets 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. - */ "actions/get-workflow-run-attempt": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * List jobs for a workflow run attempt - * @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/github-ae@latest/rest/guides/getting-started-with-the-rest-api#parameters). - */ "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85545,51 +91735,56 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download workflow run attempt logs - * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. 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. - */ "actions/download-workflow-run-attempt-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Cancel a workflow run - * @description Cancels a workflow run using its `id`. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. - */ "actions/cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -85597,25 +91792,27 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Force cancel a workflow run - * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. - * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-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. - */ "actions/force-cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -85623,29 +91820,34 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List jobs for a workflow run - * @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/github-ae@latest/rest/guides/getting-started-with-the-rest-api#parameters). - */ "actions/list-jobs-for-workflow-run": { parameters: { query?: { /** @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. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85656,127 +91858,142 @@ export interface operations { }; }; }; - /** - * Download workflow run logs - * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. 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. - */ "actions/download-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Delete workflow run logs - * @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. - */ "actions/delete-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Re-run a workflow - * @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. - */ "actions/re-run-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": Record | null; + "application/json": Record; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get workflow run usage - * @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 AE-hosted runners. Usage is listed for each GitHub AE-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-ae@latest/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. - */ "actions/get-workflow-run-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run-usage"]; }; }; }; }; - /** - * List repository secrets - * @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. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85787,73 +92004,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @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. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/github-ae@latest/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -85868,59 +92083,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository 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. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ "actions/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository workflows - * @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. - */ "actions/list-repo-workflows": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85931,63 +92158,71 @@ export interface operations { }; }; }; - /** - * Get a workflow - * @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. - */ "actions/get-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow"]; }; }; }; }; - /** - * Disable a workflow - * @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`. - * - * 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. - */ "actions/disable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * 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`. - * - * You 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)." - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line)." - */ "actions/create-workflow-dispatch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86004,62 +92239,80 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a workflow - * @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`. - * - * 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. - */ "actions/enable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow runs for a workflow - * @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/github-ae@latest/rest/guides/getting-started-with-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. - */ "actions/list-workflow-runs": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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/github-ae@latest/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; + /** @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`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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/github-ae@latest/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -86070,49 +92323,57 @@ export interface operations { }; }; }; - /** - * Get workflow usage - * @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 AE-hosted runners. Usage is listed for each GitHub AE-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-ae@latest/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * 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. - */ "actions/get-workflow-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-usage"]; }; }; }; }; - /** - * List assignees - * @description Lists the [available assignees](https://docs.github.com/github-ae@latest/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. - */ "issues/list-assignees": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -86121,67 +92382,75 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user can be assigned - * @description Checks if a user has permission to be assigned to an issue in this repository. - * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - * - * Otherwise a `404` status code is returned. - */ "issues/check-user-can-be-assigned": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Otherwise a `404` status code is returned. */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get all autolinks of a repository - * @description Gets all autolinks that are configured for a repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/list-autolinks": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"][]; }; }; }; }; - /** - * Create an autolink reference for a repository - * @description Users with admin access to the repository can create an autolink. - */ "repos/create-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -86204,6 +92473,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["autolink"]; @@ -86212,23 +92482,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an autolink reference of a repository - * @description This returns a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/get-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"]; }; @@ -86236,47 +92510,58 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an autolink reference from a repository - * @description This deletes a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/delete-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** List branches */ "repos/list-branches": { parameters: { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-branch"][]; @@ -86285,18 +92570,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get a branch */ "repos/get-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -86305,21 +92599,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get branch protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-protection"]; }; @@ -86327,23 +92627,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update branch protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Protecting a branch requires admin or owner permissions to the repository. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. - */ "repos/update-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -86355,6 +92651,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -86419,6 +92716,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch"]; }; @@ -86428,148 +92728,178 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete branch protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get admin branch protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Set admin branch protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/set-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Delete admin branch protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/delete-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get pull request review protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - /** - * Delete pull request review protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/delete-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update pull request review protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - */ "repos/update-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86604,6 +92934,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; @@ -86611,25 +92944,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get commit signature protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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/github-ae@latest/articles/signing-commits-with-gpg) in GitHub Help. - * - * **Note**: You must enable branch protection to require signed commits. - */ "repos/get-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -86637,23 +92972,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create commit signature protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/create-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -86661,43 +93000,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete commit signature protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * When 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. - */ "repos/delete-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get status checks protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-status-checks-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -86705,38 +93054,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove status check protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update status check protection - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/update-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86746,6 +93101,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -86761,6 +93117,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -86769,21 +93128,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all status check contexts - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/get-all-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -86791,17 +93156,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set status check contexts - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/set-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86814,6 +93181,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -86822,17 +93192,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add status check contexts - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/add-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86845,6 +93217,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -86854,17 +93229,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove status check contexts - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - */ "repos/remove-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86877,6 +93254,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -86885,25 +93265,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists who has access to this protected branch. - * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. - */ "repos/get-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-restriction-policy"]; }; @@ -86911,44 +93293,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Disables the ability to restrict who can push to this branch. - */ "repos/delete-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get apps with access to the protected branch - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists 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. - */ "repos/get-apps-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -86956,19 +93346,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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-ae@latest/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. - */ "repos/set-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86981,6 +93371,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -86988,19 +93381,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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-ae@latest/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. - */ "repos/add-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87013,6 +93406,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -87020,19 +93416,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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-ae@latest/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. - */ "repos/remove-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87045,6 +93441,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -87052,23 +93451,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get teams with access to the protected branch - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. The list includes child teams. - */ "repos/get-teams-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -87076,19 +93479,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - */ "repos/set-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87101,6 +93504,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -87108,19 +93514,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified teams push access for this branch. You can also give push access to child teams. - */ "repos/add-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87133,6 +93539,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -87140,19 +93549,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. - */ "repos/remove-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87165,6 +93574,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -87172,23 +93584,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get users with access to the protected branch - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - */ "repos/get-users-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -87196,23 +93612,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set user 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/set-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87225,6 +93637,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -87232,23 +93647,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add user 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified people push access for this branch. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/add-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87261,6 +93672,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -87268,23 +93682,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user 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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a user to push to this branch. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/remove-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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/github-ae@latest/graphql). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -87297,6 +93707,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -87304,20 +93717,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. - * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - */ "checks/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87343,7 +93753,7 @@ export interface operations { started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ conclusion?: @@ -87417,143 +93827,147 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Get a check run - * @description Gets a single check run using its `id`. - * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - */ "checks/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * Update a check run - * @description Updates a check run for a specific commit in a repository. - * - * To update a check run, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to update a check run. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - */ "checks/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The name of the check. For example, "code-coverage". */ - name?: string; - /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; - /** @description A reference for the run on the integrator's system. */ - external_id?: string; - /** - * Format: date-time - * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * @description The current status. - * @enum {string} - */ - status?: "queued" | "in_progress" | "completed"; - /** - * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. - * @enum {string} - */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; - /** - * Format: date-time - * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - completed_at?: string; - /** @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. */ - output?: { - /** @description **Required**. */ - title?: string; - /** @description Can contain Markdown. */ - summary: string; - /** @description Can contain Markdown. */ - text?: string; - /** @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/github-ae@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/github-ae@latest/articles/about-status-checks#checks)". */ - annotations?: { - /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; - /** @description The start line of the annotation. Line numbers start at 1. */ - start_line: number; - /** @description The end line of the annotation. */ - end_line: number; - /** @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. */ - start_column?: number; - /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; + "application/json": + | { + /** @description The name of the check. For example, "code-coverage". */ + name?: string; + /** @description The URL of the integrator's site that has the full details of the check. */ + details_url?: string; + /** @description A reference for the run on the integrator's system. */ + external_id?: string; /** - * @description The level of the annotation. + * Format: date-time + * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * @description The current status. * @enum {string} */ - annotation_level: "notice" | "warning" | "failure"; - /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; - /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; - /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; - /** @description Adds images to the output displayed in the GitHub pull request UI. */ - images?: { - /** @description The alternative text for the image. */ - alt: string; - /** @description The full URL of the image. */ - image_url: string; - /** @description A short image description. */ - caption?: string; - }[]; - }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - actions?: { - /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; - /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; - /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - } & ( + status?: "queued" | "in_progress" | "completed"; + /** + * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * @enum {string} + */ + conclusion?: + | "action_required" + | "cancelled" + | "failure" + | "neutral" + | "success" + | "skipped" + | "stale" + | "timed_out"; + /** + * Format: date-time + * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** @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. */ + output?: { + /** @description **Required**. */ + title?: string; + /** @description Can contain Markdown. */ + summary: string; + /** @description Can contain Markdown. */ + text?: string; + /** @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/github-ae@latest/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/github-ae@latest/articles/about-status-checks#checks)". */ + annotations?: { + /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** @description The start line of the annotation. Line numbers start at 1. */ + start_line: number; + /** @description The end line of the annotation. */ + end_line: number; + /** @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. */ + start_column?: number; + /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** + * @description The level of the annotation. + * @enum {string} + */ + annotation_level: "notice" | "warning" | "failure"; + /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** @description The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** @description Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + }[]; + /** @description Adds images to the output displayed in the GitHub pull request UI. */ + images?: { + /** @description The alternative text for the image. */ + alt: string; + /** @description The full URL of the image. */ + image_url: string; + /** @description A short image description. */ + caption?: string; + }[]; + }; + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/github-ae@latest/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + actions?: { + /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + }[]; + } | { /** @enum {unknown} */ status?: "completed"; @@ -87563,46 +93977,47 @@ export interface operations { /** @enum {unknown} */ status?: "queued" | "in_progress"; [key: string]: unknown; - } - ); + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. - * - * GitHub Apps - * must have the `checks:read` permission on a private repository or pull access to - * a public repository to get annotations for a check run. OAuth apps and authenticated - * users must have the `repo` scope to get annotations for a check run in a private - * repository. - */ "checks/list-annotations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["check-annotation"][]; @@ -87610,31 +94025,36 @@ export interface operations { }; }; }; - /** - * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * To rerequest a check run, you must use a GitHub App with the `checks:read` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check run. - * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/github-ae@latest/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - */ "checks/rerequest-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -87642,26 +94062,26 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/github-ae@latest/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/github-ae@latest/rest/checks/suites#update-repository-preferences-for-check-suites)". - * - * To create a check suite, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to create a check suite. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - */ "checks/create-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87674,29 +94094,35 @@ export interface operations { responses: { /** @description Response when the suite already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/github-ae@latest/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. - */ "checks/set-suites-preferences": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -87717,66 +94143,74 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - /** - * Get a check suite - * @description Gets a single check suite using its `id`. - * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - */ "checks/get-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. - * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - */ "checks/list-for-suite": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -87787,47 +94221,47 @@ export interface operations { }; }; }; - /** - * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * To rerequest a check suite, you must use a GitHub App with the `checks:write` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check suite. - */ "checks/rerequest-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List code scanning alerts for a repository - * @description Lists code scanning alerts. - * - * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch (or for the specified Git reference if you used `ref` in the request). - */ "code-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created" | "updated"; @@ -87836,14 +94270,22 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-items"][]; }; @@ -87854,21 +94296,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories, the `public_repo` scope also grants permission to read security events on public repositories only. - */ "code-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -87879,17 +94327,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. - */ "code-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -87902,6 +94352,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -87911,28 +94364,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List instances of a code scanning alert - * @description Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repositories, - * the `public_repo` scope also grants permission to read security events on public repositories only. - */ "code-scanning/list-alert-instances": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-instance"][]; }; @@ -87942,48 +94401,42 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List code scanning analyses for a repository - * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. - * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * You must use an access token with the `security_events` scope to use this endpoint with private repositories, - * the `public_repo` scope also grants permission to read security events on public repositories only. - * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. - */ "code-scanning/list-recent-analyses": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the analyses 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`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"][]; }; @@ -87993,39 +94446,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning analysis for a repository - * @description Gets a specified code scanning analysis for a repository. - * - * You must use an access token with the `security_events` scope to use this endpoint with private repositories, - * the `public_repo` scope also grants permission to read security events on public repositories only. - * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. - * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. - */ "code-scanning/get-analysis": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { @@ -88038,89 +94479,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. For - * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` and `repo:security_events` scopes. - * GitHub Apps must have the `security_events` write permission to use this endpoint. - * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `analysis_key` - * * `environment` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - */ "code-scanning/delete-analysis": { parameters: { query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ confirm_delete?: string | null; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; @@ -88131,42 +94513,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. - * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." - * - * You 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: - * - * ``` - * 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 these values. 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 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 | | - * | 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. | - * - * - * The `202 Accepted` response includes an `id` value. - * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." - */ "code-scanning/upload-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -88177,7 +94534,7 @@ export interface operations { /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. - * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ checkout_uri?: string; @@ -88194,39 +94551,53 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ 413: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repositories, the `public_repo` scope also grants permission to read security events on public repositories only. - */ "code-scanning/get-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ sarif_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; @@ -88234,54 +94605,49 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CODEOWNERS errors - * @description List any syntax errors that are detected in the CODEOWNERS - * file. - * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/github-ae@latest/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - */ "repos/codeowners-errors": { parameters: { query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository collaborators - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. - * - * Team members will include the members of child teams. - * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. - */ "repos/list-collaborators": { parameters: { query?: { @@ -88289,19 +94655,27 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["collaborator"][]; @@ -88310,60 +94684,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is a repository collaborator - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * Team members will include the members of child teams. - * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. - */ "repos/check-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a collaborator */ 404: { - content: never; - }; - }; - }; - /** - * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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/github-ae@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-ae@latest/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: - * - * ``` - * Cannot assign {member} permission of {role name} - * ``` - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **Updating an existing collaborator's permission level** - * - * The 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. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88377,81 +94742,68 @@ export interface operations { }; }; responses: { - /** - * @description Response when: - * - an existing collaborator is added as a collaborator - * - an organization member is added as an individual collaborator - * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator - */ + /** @description Response when: + * - an existing collaborator is added as a collaborator + * - an organization member is added as an individual collaborator + * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository collaborator - * @description Removes a collaborator from a repository. - * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. - * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages - * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. - * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". - */ "repos/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when collaborator was removed from the repository. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ "repos/get-collaborator-permission-level": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user has admin permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-collaborator-permission"]; }; @@ -88459,33 +94811,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit comments for a repository - * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-commit-comments-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -88493,28 +94842,27 @@ export interface operations { }; }; }; - /** - * Get a commit comment - * @description Gets a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/get-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -88522,41 +94870,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a commit comment */ "repos/delete-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a commit comment - * @description Updates the contents of a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/update-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88569,6 +94921,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -88576,10 +94931,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment). - */ "reactions/list-for-commit-comment": { parameters: { query?: { @@ -88593,20 +94944,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -88615,17 +94975,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. - */ "reactions/create-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -88649,12 +95011,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -88663,59 +95031,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to a [commit comment](https://docs.github.com/github-ae@latest/rest/commits/comments#get-a-commit-comment). - */ "reactions/delete-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List commits - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/list-commits": { parameters: { query?: { @@ -88727,22 +95069,31 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -88754,23 +95105,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List branches for HEAD commit - * @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-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - */ "repos/list-branches-for-head-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-short"][]; }; @@ -88778,34 +95133,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List commit comments - * @description Lists the comments for a specified commit. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-comments-for-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -88813,26 +95166,19 @@ export interface operations { }; }; }; - /** - * Create a commit comment - * @description Create a comment for a commit using its `:commit_sha`. - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/create-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; requestBody: { content: { @@ -88854,6 +95200,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"]; @@ -88863,29 +95210,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. - * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. - */ "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -88893,62 +95243,32 @@ export interface operations { }; }; }; - /** - * Get a commit - * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - * - * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/get-commit": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; @@ -88959,38 +95279,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. - */ "checks/list-for-ref": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; app_id?: number; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89001,14 +95322,6 @@ export interface operations { }; }; }; - /** - * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - * - * GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - */ "checks/list-suites-for-ref": { parameters: { query?: { @@ -89017,21 +95330,31 @@ export interface operations { * @example 1 */ app_id?: number; + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -89042,32 +95365,32 @@ export interface operations { }; }; }; - /** - * Get the combined status for a specific reference - * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - * - * - * Additionally, a combined `state` is returned. The `state` is one of: - * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` - */ "repos/get-combined-status-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-commit-status"]; }; @@ -89075,29 +95398,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit statuses for a reference - * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - */ "repos/list-commit-statuses-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"][]; @@ -89106,75 +95432,32 @@ export interface operations { 301: components["responses"]["moved_permanently"]; }; }; - /** - * Compare two commits - * @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/github-ae@latest/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. - * - * **Working with large comparisons** - * - * 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. - * - * For more information on working with pagination, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api)." - * - * **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: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits-with-basehead": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @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`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; @@ -89184,58 +95467,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit - * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. - * - * Files and symlinks support [a custom media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) for - * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/github-ae@latest/rest/overview/media-types) to ensure the content is returned in a consistent - * object format. - * - * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/github-ae@latest/rest/git/trees#get-a-tree). - * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * * This API supports files up to 1 megabyte in size. - * - * If the content is a directory: - * The response will be an array of objects, one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink: - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object - * describing the symlink itself. - * - * If the content is a submodule: - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out - * the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the - * github.com URLs (`html_url` and `_links["html"]`) will have null values. - */ "repos/get-content": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/vnd.github.object": components["schemas"]["content-tree"]; "application/json": @@ -89250,20 +95505,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. - * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/github-ae@latest/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - */ "repos/create-or-update-file-contents": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -89300,12 +95554,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -89315,26 +95575,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a file - * @description Deletes a file in a repository. - * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/github-ae@latest/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - */ "repos/delete-file": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -89365,6 +95618,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -89375,30 +95631,32 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository contributors - * @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. - * - * 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. - */ "repos/list-contributors": { parameters: { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If repository contains content */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["contributor"][]; @@ -89406,16 +95664,15 @@ export interface operations { }; /** @description Response if repository is empty */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List deployments - * @description Simple filtering of deployments is available via query parameters: - */ "repos/list-deployments": { parameters: { query?: { @@ -89426,20 +95683,28 @@ export interface operations { /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment"][]; @@ -89447,63 +95712,17 @@ export interface operations { }; }; }; - /** - * Create a deployment - * @description Deployments offer a few configurable parameters with certain defaults. - * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub AE we often deploy branches and verify them - * before we merge a pull request. - * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. - * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. - * - * By default, [commit statuses](https://docs.github.com/github-ae@latest/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. - * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. - * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. - * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - * - * Merged branch response: - * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts - * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. - * - * Merge conflict response: - * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * Failed commit status checks: - * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - */ "repos/create-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -89522,14 +95741,11 @@ export interface operations { auto_merge?: boolean; /** @description The [status](https://docs.github.com/github-ae@latest/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; - payload?: OneOf< - [ - { + payload?: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production @@ -89553,12 +95769,18 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -89567,23 +95789,35 @@ export interface operations { }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** Get a deployment */ "repos/get-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; @@ -89591,55 +95825,59 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * To set a deployment as inactive, you must: - * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. - * - * For more information, see "[Create a deployment](https://docs.github.com/github-ae@latest/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/github-ae@latest/rest/deployments/statuses#create-a-deployment-status)." - */ "repos/delete-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List deployment statuses - * @description Users with pull access can view deployment statuses for a deployment: - */ "repos/list-deployment-statuses": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"][]; @@ -89648,19 +95886,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a deployment status - * @description Users with `push` access can create deployment statuses for a given deployment. - * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. - */ "repos/create-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89710,6 +95948,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"]; @@ -89718,22 +95957,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a deployment status - * @description Users with pull access can view a deployment status for a deployment: - */ "repos/get-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; status_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-status"]; }; @@ -89741,25 +95986,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub AE to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#repository_dispatch)." - * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - * - * This endpoint requires write access to the repository by providing either: - * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/github-ae@latest/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. - */ "repos/create-dispatch-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -89776,31 +96013,38 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * List environments - * @description Lists the environments 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. - */ "repos/get-all-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -89814,48 +96058,46 @@ export interface operations { }; }; }; - /** - * Get an environment - * @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)." - * - * 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. - */ "repos/get-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; }; }; - /** - * Create or update an environment - * @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)." - * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. - */ "repos/create-or-update-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89880,58 +96122,75 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Delete an environment - * @description You must authenticate using an access token with the repo scope to use this endpoint. - */ "repos/delete-an-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List deployment branch policies - * @description Lists the deployment branch policies for an environment. - * - * 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. - */ "repos/list-deployment-branch-policies": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -89945,19 +96204,19 @@ export interface operations { }; }; }; - /** - * Create a deployment branch policy - * @description Creates a deployment branch or tag policy for an environment. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. - */ "repos/create-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -89967,58 +96226,73 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ 303: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a deployment branch policy - * @description Gets a deployment branch or tag policy for an environment. - * - * 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. - */ "repos/get-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Update a deployment branch policy - * @description Updates a deployment branch or tag policy for an environment. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. - */ "repos/update-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -90028,77 +96302,98 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Delete a deployment branch policy - * @description Deletes a deployment branch or tag policy for an environment. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. - */ "repos/delete-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - */ "activity/list-repo-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List forks */ "repos/list-forks": { parameters: { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -90107,20 +96402,17 @@ export interface operations { 400: components["responses"]["bad_request"]; }; }; - /** - * Create a fork - * @description Create a fork for the authenticated user. - * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub AE Support](https://support.github.com/contact?tags=dotcom-rest-api). - * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. - */ "repos/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90133,6 +96425,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -90143,13 +96438,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Create a blob */ "git/create-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90170,6 +96469,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-blob"]; @@ -90181,28 +96481,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a blob - * @description The `content` in the response will always be Base64 encoded. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. - * - * **Note** This endpoint supports blobs up to 100 megabytes in size. - */ "git/get-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; file_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["blob"]; }; @@ -90212,45 +96510,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a commit - * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90296,6 +96566,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-commit"]; @@ -90305,52 +96576,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a commit object - * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-commit"]; }; @@ -90358,29 +96604,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List matching references - * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - */ "git/list-matching-refs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"][]; @@ -90388,23 +96632,27 @@ export interface operations { }; }; }; - /** - * Get a reference - * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - */ "git/get-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -90412,16 +96660,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a reference - * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. - */ "git/create-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90439,6 +96688,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"]; @@ -90447,28 +96697,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Delete a reference */ "git/delete-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** Update a reference */ "git/update-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. @@ -90476,6 +96738,7 @@ export interface operations { */ ref: string; }; + cookie?: never; }; requestBody: { content: { @@ -90493,6 +96756,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -90500,45 +96766,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/github-ae@latest/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/github-ae@latest/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90575,6 +96813,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tag"]; @@ -90583,48 +96822,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tag - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; tag_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tag"]; }; @@ -90632,20 +96849,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a tree - * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/github-ae@latest/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/github-ae@latest/rest/git/refs#update-a-reference)." - * - * Returns an error if you try to delete a file that does not exist. - */ "git/create-tree": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90664,23 +96878,18 @@ export interface operations { * @enum {string} */ type?: "blob" | "tree" | "commit"; - /** - * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + /** @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ sha?: string | null; - /** - * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + /** @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ content?: string; }[]; - /** - * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - */ + /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + * */ base_tree?: string; }; }; @@ -90691,6 +96900,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tree"]; @@ -90701,31 +96911,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tree - * @description Returns a single tree using the SHA1 value or ref name for that tree. - * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. - */ "git/get-tree": { parameters: { query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ recursive?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tree"]; }; @@ -90734,26 +96943,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository webhooks - * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. - */ "repos/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"][]; @@ -90762,17 +96975,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository webhook - * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. - */ "repos/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90789,8 +97002,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -90807,6 +97020,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"]; @@ -90817,21 +97031,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." - */ "repos/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -90839,34 +97059,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ "repos/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." - */ "repos/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -90875,8 +97106,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ @@ -90894,6 +97125,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -90902,42 +97136,46 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - * - * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. - */ "repos/get-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - * - * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. - */ "repos/update-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90952,32 +97190,42 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for a repository webhook - * @description Returns a list of webhook deliveries for a webhook configured in a repository. - */ "repos/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -90986,22 +97234,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for a repository webhook - * @description Returns a delivery for a webhook configured in a repository. - */ "repos/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -91010,83 +97264,99 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for a repository webhook - * @description Redeliver a webhook delivery for a webhook configured in a repository. - */ "repos/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook. - */ "repos/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Test the push repository webhook - * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - */ "repos/test-push-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository installation for the authenticated app - * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-repo-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -91095,26 +97365,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repository invitations - * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. - */ "repos/list-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -91122,30 +97396,44 @@ export interface operations { }; }; }; - /** Delete a repository invitation */ "repos/delete-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a repository invitation */ "repos/update-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -91161,28 +97449,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - /** - * List repository issues - * @description List issues in a repository. Only open issues will be listed. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-repo": { parameters: { query?: { @@ -91196,24 +97471,35 @@ export interface operations { creator?: string; /** @description A user that's mentioned in the issue. */ mentioned?: string; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -91224,26 +97510,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/github-ae@latest/articles/disabling-issues/), the API returns a `410 Gone` status. - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -91254,19 +97531,17 @@ export interface operations { body?: string; /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ assignee?: string | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; }; @@ -91278,6 +97553,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"]; @@ -91291,39 +97567,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List issue comments for a repository - * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. - * - * By default, issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments-for-repo": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -91333,28 +97606,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue comment - * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -91362,43 +97634,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an issue comment - * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - */ "issues/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an issue comment - * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91411,6 +97684,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -91418,10 +97694,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment). - */ "reactions/list-for-issue-comment": { parameters: { query?: { @@ -91435,20 +97707,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -91457,17 +97738,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. - */ "reactions/create-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91491,12 +97774,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -91504,48 +97793,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to an [issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#get-an-issue-comment). - */ "reactions/delete-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List issue events for a repository - * @description Lists events for a repository. - */ "issues/list-events-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event"][]; @@ -91554,21 +97852,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue event - * @description Gets a single event by the event id. - */ "issues/get-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; event_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-event"]; }; @@ -91578,38 +97881,27 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/github-ae@latest/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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/github-ae@latest/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 - * 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/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -91620,30 +97912,25 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update an issue - * @description Issue owners and users with push access can edit an issue. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** @description The title of the issue. */ - title?: string | number | null; + title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; /** @description Username to assign to this issue. **This field is deprecated.** */ @@ -91659,19 +97946,17 @@ export interface operations { * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; }; @@ -91680,6 +97965,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -91692,17 +97980,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Add assignees to an issue - * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - */ "issues/add-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -91715,23 +98005,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Remove assignees from an issue - * @description Removes one or more assignees from an issue. - */ "issues/remove-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -91744,73 +98039,78 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Check if a user can be assigned to a issue - * @description 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. - */ "issues/check-user-can-be-assigned-to-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List issue comments - * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * Issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -91820,29 +98120,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create an issue comment - * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). - * Creating content too quickly using this endpoint may result in secondary rate limiting. - * For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -91858,6 +98148,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"]; @@ -91869,27 +98160,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List issue events - * @description Lists all events for an issue. - */ "issues/list-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event-for-issue"][]; @@ -91898,27 +98194,32 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * List labels for an issue - * @description Lists all labels for an issue. - */ "issues/list-labels-on-issue": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -91929,38 +98230,40 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Set labels for an issue - * @description Removes any previous labels and sets the new labels for an issue. - */ "issues/set-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/github-ae@latest/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -91971,38 +98274,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. - */ "issues/add-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/github-ae@latest/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -92013,44 +98318,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all labels from an issue - * @description Removes all labels from an issue. - */ "issues/remove-all-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 301: components["responses"]["moved_permanently"]; 404: components["responses"]["not_found"]; 410: components["responses"]["gone"]; }; }; - /** - * Remove a label from an issue - * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. - */ "issues/remove-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -92060,29 +98377,29 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Lock an issue - * @description Users with push access can lock an issue or pull request's conversation. - * - * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "issues/lock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` * @enum {string} */ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; @@ -92092,7 +98409,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -92100,31 +98420,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unlock an issue - * @description Users with push access can unlock an issue's conversation. - */ "issues/unlock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue). - */ "reactions/list-for-issue": { parameters: { query?: { @@ -92138,20 +98460,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -92161,17 +98492,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. - */ "reactions/create-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -92195,12 +98528,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -92208,49 +98547,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - * - * Delete a reaction to an [issue](https://docs.github.com/github-ae@latest/rest/issues/issues#get-an-issue). - */ "reactions/delete-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List timeline events for an issue - * @description List all timeline events for an issue. - */ "issues/list-events-for-timeline": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["timeline-issue-events"][]; @@ -92260,23 +98609,30 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** List deploy keys */ "repos/list-deploy-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"][]; @@ -92284,16 +98640,17 @@ export interface operations { }; }; }; - /** - * Create a deploy key - * @description You can create a read-only deploy key. - */ "repos/create-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92302,11 +98659,9 @@ export interface operations { title?: string; /** @description The contents of the key. */ key: string; - /** - * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + /** @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/github-ae@latest/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/github-ae@latest/articles/permission-levels-for-a-user-account-repository/)." - */ + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/github-ae@latest/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/github-ae@latest/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; }; @@ -92317,6 +98672,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"]; @@ -92325,18 +98681,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get a deploy key */ "repos/get-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deploy-key"]; }; @@ -92344,45 +98709,55 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a deploy key - * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. - */ "repos/delete-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a repository - * @description Lists all labels for a repository. - */ "issues/list-labels-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -92391,16 +98766,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a label - * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). - */ "issues/create-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92420,6 +98796,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"]; @@ -92429,21 +98806,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a label - * @description Gets a label using the given name. - */ "issues/get-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; @@ -92451,36 +98833,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a label - * @description Deletes a label using the given label name. - */ "issues/delete-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a label - * @description Updates a label using the given label name. - */ "issues/update-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; requestBody?: { content: { @@ -92497,94 +98885,110 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; }; }; }; - /** - * List repository languages - * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. - */ "repos/list-languages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["language"]; }; }; }; }; - /** - * Enable Git LFS for a repository - * @description Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ "repos/enable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; - /** - * @description We will return a 403 with one of the following messages: + /** @description We will return a 403 with one of the following messages: * - * - Git LFS support not enabled because Git LFS is globally disabled. - * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. - * - Git LFS support not enabled because Git LFS is disabled for . - */ + * - Git LFS support not enabled because Git LFS is globally disabled. + * - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + * - Git LFS support not enabled because Git LFS is disabled for . */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable Git LFS for a repository - * @description Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope. - */ "repos/disable-lfs-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the license for a repository - * @description This method returns the contents of the repository's license file, if one is detected. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "licenses/get-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-content"]; }; @@ -92592,16 +98996,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Sync a fork branch with the upstream repository - * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. - */ "repos/merge-upstream": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92614,27 +99019,40 @@ export interface operations { responses: { /** @description The branch has been successfully synced with the upstream repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The branch could not be synced for some other reason */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Merge a branch */ "repos/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92651,30 +99069,38 @@ export interface operations { responses: { /** @description Successful Response (The resulting merge commit) */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when there is a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * List milestones - * @description Lists milestones for a repository. - */ "issues/list-milestones": { parameters: { query?: { @@ -92684,19 +99110,27 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"][]; @@ -92705,16 +99139,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a milestone - * @description Creates a milestone. - */ "issues/create-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92743,6 +99178,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"]; @@ -92752,21 +99188,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a milestone - * @description Gets a milestone using the given milestone number. - */ "issues/get-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; @@ -92774,34 +99216,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a milestone - * @description Deletes a milestone using the given milestone number. - */ "issues/delete-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** Update a milestone */ "issues/update-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92827,33 +99280,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; }; }; }; - /** - * List labels for issues in a milestone - * @description Lists labels for issues in a milestone. - */ "issues/list-labels-for-milestone": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -92861,30 +99322,38 @@ export interface operations { }; }; }; - /** - * List repository notifications for the authenticated user - * @description Lists all notifications for the current user in the specified repository. - */ "activity/list-repo-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -92892,16 +99361,17 @@ export interface operations { }; }; }; - /** - * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE 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/github-ae@latest/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-repo-notifications-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92917,6 +99387,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -92926,26 +99399,32 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a GitHub AE Pages site - * @description Gets information about a GitHub AE Pages site. - * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. - */ "repos/get-pages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -92953,93 +99432,109 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update information about a GitHub AE Pages site - * @description Updates information for a GitHub AE 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 `administration:write` and `pages:write` permissions. - */ "repos/update-information-about-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/github-ae@latest/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @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. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: - | ("gh-pages" | "master" | "master /docs") - | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - }; + "application/json": + | { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/github-ae@latest/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @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. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: + | ("gh-pages" | "master" | "master /docs") + | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + } + | unknown + | unknown + | unknown + | unknown + | unknown; }; }; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["bad_request"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a GitHub AE Pages site - * @description Configures a GitHub AE 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 `administration:write` and `pages:write` permissions. - */ "repos/create-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } | null; + "application/json": + | ( + | { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } + | unknown + | unknown + ) + | null; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -93048,51 +99543,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a GitHub AE Pages site - * @description Deletes a GitHub AE 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 `administration:write` and `pages:write` permissions. - */ "repos/delete-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List GitHub AE Pages builds - * @description Lists builts of a GitHub AE Pages site. - * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. - */ "repos/list-pages-builds": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["page-build"][]; @@ -93100,95 +99600,108 @@ export interface operations { }; }; }; - /** - * Request a GitHub AE Pages build - * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - */ "repos/request-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - /** - * Get latest Pages build - * @description Gets information about the single most recent build of a GitHub AE Pages site. - * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. - */ "repos/get-latest-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Get GitHub AE Pages build - * @description Gets information about a GitHub AE Pages build. - * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. - */ "repos/get-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; build_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-repo": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -93201,16 +99714,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93225,6 +99739,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -93236,25 +99753,6 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List pull requests - * @description Lists pull requests in a specified repository. - * - * 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-ae@latest/github/getting-started-with-github/githubs-products) - * in the GitHub Help documentation. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - * - **`application/vnd.github.patch`**: For more information, see "[git-format-patch](https://git-scm.com/docs/git-format-patch)" in the Git documentation. - */ "pulls/list": { parameters: { query?: { @@ -93268,19 +99766,27 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -93290,28 +99796,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ "pulls/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93343,6 +99838,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request"]; @@ -93352,38 +99848,35 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments-for-repo": { parameters: { query?: { sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -93391,28 +99884,27 @@ export interface operations { }; }; }; - /** - * Get a review comment for a pull request - * @description Provides details for a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; @@ -93420,44 +99912,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a review comment for a pull request - * @description Deletes a review comment. - */ "pulls/delete-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a review comment for a pull request - * @description Edits the content of a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -93470,16 +99963,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - /** - * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { @@ -93493,20 +99985,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -93515,17 +100016,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. - */ "reactions/create-for-pull-request-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -93549,12 +100052,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -93562,65 +100071,54 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - * - * Delete a reaction to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/delete-for-pull-request-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Get a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists details of a pull request by providing its number. - * - * When you get, [create](https://docs.github.com/github-ae@latest/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/github-ae@latest/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub AE creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub AE has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * - * * If merged as a [merge commit](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/github-ae@latest/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - * - * Pass the appropriate [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "pulls/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Pass the appropriate [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -93631,27 +100129,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ "pulls/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93675,6 +100165,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -93683,39 +100176,38 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments on a pull request - * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -93723,31 +100215,19 @@ export interface operations { }; }; }; - /** - * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/github-ae@latest/rest/issues/comments#create-an-issue-comment)." - * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -93791,6 +100271,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -93800,28 +100281,21 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a reply for a review comment - * @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. - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-reply-for-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -93837,6 +100311,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -93845,37 +100320,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/github-ae@latest/rest/commits/commits#list-commits) - * endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ "pulls/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -93883,38 +100353,32 @@ export interface operations { }; }; }; - /** - * List pull requests files - * @description Lists the files in a specified pull request. - * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ "pulls/list-files": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["diff-entry"][]; @@ -93925,41 +100389,51 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Check if a pull request has been merged - * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. - */ "pulls/check-if-merged": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if pull request has been merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if pull request has not been merged */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Merge a pull request - * @description Merges a pull request into the base branch. - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - */ "pulls/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93981,6 +100455,9 @@ export interface operations { responses: { /** @description if merge was successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-merge-result"]; }; @@ -93989,6 +100466,9 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ 405: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -93998,6 +100478,9 @@ export interface operations { }; /** @description Conflict if sha was provided and pull request head did not match */ 409: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94008,23 +100491,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. - */ "pulls/list-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-request"]; @@ -94032,17 +100519,19 @@ export interface operations { }; }; }; - /** - * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - */ "pulls/request-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94057,6 +100546,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -94064,21 +100556,26 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove requested reviewers from a pull request - * @description Removes review requests from a pull request for a given set of users and/or teams. - */ "pulls/remove-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -94093,6 +100590,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -94100,34 +100600,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reviews for a pull request - * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-reviews": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The list of reviews returns in chronological order. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review"][]; @@ -94135,32 +100633,19 @@ export interface operations { }; }; }; - /** - * Create a review for a pull request - * @description Creates a review on a specified pull request. - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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/github-ae@latest/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/github-ae@latest/rest/pulls/pulls#get-a-pull-request) endpoint. - * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94197,6 +100682,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -94205,29 +100693,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a review for a pull request - * @description Retrieves a pull request review by its ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -94235,25 +100723,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a review for a pull request - * @description Updates the contents of a specified review summary comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94266,6 +100750,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -94273,29 +100760,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete a pending review for a pull request - * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/delete-pending-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -94304,35 +100791,34 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List comments for a pull request review - * @description Lists comments for a specific pull request review. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-comments-for-review": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["review-comment"][]; @@ -94341,29 +100827,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Dismiss a review for a pull request - * @description Dismisses a specified review on a pull request. - * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/github-ae@latest/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/dismiss-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94381,6 +100859,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -94389,25 +100870,21 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/github-ae@latest/rest/pulls/reviews#create-a-review-for-a-pull-request)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/submit-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94425,6 +100902,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -94434,17 +100914,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Update a pull request branch - * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - */ "pulls/update-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94457,6 +100939,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -94468,29 +100953,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README - * @description Gets the preferred README for a repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -94499,31 +100983,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README for a directory - * @description Gets the README from a repository directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme-in-directory": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ dir: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -94532,28 +101015,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/github-ae@latest/rest/repos/repos#list-repository-tags). - * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - */ "repos/list-releases": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"][]; @@ -94562,18 +101047,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a release - * @description Users with push access to the repository can create a release. - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - */ "repos/create-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94605,6 +101089,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"]; @@ -94613,21 +101098,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/github-ae@latest/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. - */ "repos/get-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; @@ -94636,33 +101127,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a release asset */ "repos/delete-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release asset - * @description Users with push access to the repository can edit a release asset. - */ "repos/update-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94679,50 +101181,61 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; }; }; - /** - * Get the latest release - * @description View the latest published full release for the repository. - * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - */ "repos/get-latest-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** - * Get a release by tag name - * @description Get a published release with the specified tag. - */ "repos/get-release-by-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description tag parameter */ tag: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; @@ -94730,65 +101243,78 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a release - * @description Gets a public release with the specified release ID. - * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - */ "repos/get-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a release - * @description Users with push access to the repository can delete a release. - */ "repos/delete-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release - * @description Users with push access to the repository can edit a release. - */ "repos/update-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94811,30 +101337,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** List release assets */ "repos/list-release-assets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release-asset"][]; @@ -94842,39 +101379,22 @@ export interface operations { }; }; }; - /** - * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/github-ae@latest/rest/releases/releases#create-a-release) to upload a release asset. - * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - * - * `application/zip` - * - * GitHub AE expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. - * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. - * - * **Notes:** - * * GitHub AE renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/github-ae@latest/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub AE Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/github-ae@latest/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. - */ "repos/upload-release-asset": { parameters: { query: { name: string; label?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -94884,39 +101404,50 @@ export interface operations { responses: { /** @description Response for successful upload */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release). - */ "reactions/list-for-release": { parameters: { query?: { /** @description Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -94926,17 +101457,19 @@ export interface operations { 415: components["responses"]["preview_header_missing"]; }; }; - /** - * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. - */ "reactions/create-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -94952,12 +101485,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -94965,79 +101504,100 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - * - * Delete a reaction to a [release](https://docs.github.com/github-ae@latest/rest/releases/releases#get-a-release). - */ "reactions/delete-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List secret scanning alerts for a repository - * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. - * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. - */ "secret-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/github-ae@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a secret scanning alert - * @description Gets a single secret scanning alert detected in an eligible repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. - * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. - */ "secret-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; @@ -95045,24 +101605,27 @@ export interface operations { 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a secret scanning alert - * @description 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 organization, and you must use an access token with the `repo` scope or `security_events` scope. - * - * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. - */ "secret-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -95076,48 +101639,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description State does not match the resolution or resolution comment */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List locations for a secret scanning alert - * @description Lists all locations for a given secret scanning alert for an eligible repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope. - * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. - */ "secret-scanning/list-locations-for-alert": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["secret-scanning-location"][]; @@ -95125,35 +101703,38 @@ export interface operations { }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List stargazers - * @description Lists the people that have starred the repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-stargazers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -95164,24 +101745,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. - */ "repos/get-code-frequency-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -95190,24 +101772,32 @@ export interface operations { 204: components["responses"]["no_content"]; /** @description Repository contains more than 10,000 commits */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the last year of commit activity - * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. - */ "repos/get-commit-activity-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-activity"][]; }; @@ -95216,28 +101806,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get all contributor commit activity - * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits - * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. - */ "repos/get-contributors-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["contributor-activity"][]; }; @@ -95246,24 +101833,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the weekly commit count - * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - * - * The array order is oldest week (index 0) to most recent week. - * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. - */ "repos/get-participation-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The array order is oldest week (index 0) to most recent week. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["participation-stats"]; }; @@ -95271,26 +101859,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the hourly commit count for each day - * @description Each array contains the day number, hour number, and number of commits: - * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits - * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - */ "repos/get-punch-card-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -95298,19 +101885,18 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Create a commit status - * @description Users with push access in a repository can create commit statuses for a given SHA. - * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - */ "repos/create-commit-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; sha: string; }; + cookie?: never; }; requestBody: { content: { @@ -95320,11 +101906,9 @@ export interface operations { * @enum {string} */ state: "error" | "failure" | "pending" | "success"; - /** - * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. - * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: - * `http://ci.example.com/user/repo/build/sha` - */ + /** @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; /** @description A short description of the status. */ description?: string | null; @@ -95342,6 +101926,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"]; @@ -95349,26 +101934,30 @@ export interface operations { }; }; }; - /** - * List watchers - * @description Lists the people watching the specified repository. - */ "activity/list-watchers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -95376,20 +101965,25 @@ export interface operations { }; }; }; - /** - * Get a repository subscription - * @description Gets information about whether the authenticated user is subscribed to the repository. - */ "activity/get-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if you subscribe to the repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; @@ -95397,20 +101991,24 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/github-ae@latest/rest/activity/watching#delete-a-repository-subscription) completely. - */ "activity/set-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95425,47 +102023,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - /** - * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/github-ae@latest/rest/activity/watching#set-a-repository-subscription). - */ "activity/delete-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List repository tags */ "repos/list-tags": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["tag"][]; @@ -95473,60 +102086,56 @@ export interface operations { }; }; }; - /** - * Download a repository archive (tar) - * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. - */ "repos/download-tarball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * List repository teams - * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. - * - * For a public repository, a team is listed only if that team added the public repository explicitly. - * - * Personal access tokens require the following scopes: - * * `public_repo` to call this endpoint on a public repository - * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - * - * This endpoint is not compatible with fine-grained personal access tokens. - */ "repos/list-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -95535,21 +102144,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get all repository topics */ "repos/get-all-topics": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -95557,13 +102175,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Replace all repository topics */ "repos/replace-all-topics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95576,6 +102198,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -95584,17 +102209,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/github-ae@latest/articles/about-repository-transfers/). - * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. - */ "repos/transfer": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -95609,58 +102234,52 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - /** - * Download a repository archive (zip) - * @description 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 - * 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. - */ "repos/download-zipball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository - */ "repos/create-using-template": { parameters: { + query?: never; + header?: never; path: { /** @description The account owner of the template repository. The name is not case sensitive. */ template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ template_repo: string; }; + cookie?: never; }; requestBody: { content: { @@ -95690,6 +102309,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -95697,29 +102317,6 @@ export interface operations { }; }; }; - /** - * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). - * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: - * - * `q=addClass+in:file+language:js+repo:jquery/jquery` - * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. - * - * Considerations for code search: - * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: - * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - * - * This endpoint requires you to authenticate and limits you to 10 requests per minute. - */ "search/code": { parameters: { query: { @@ -95735,13 +102332,22 @@ export interface operations { * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -95756,17 +102362,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). - * - * 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/github-ae@latest/rest/search/search#text-match-metadata). - * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - * - * `q=repo:octocat/Spoon-Knife+css` - */ "search/commits": { parameters: { query: { @@ -95774,14 +102369,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -95793,21 +102398,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). - * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github-ae@latest/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." - */ "search/issues-and-pull-requests": { parameters: { query: { @@ -95826,14 +102416,24 @@ export interface operations { | "interactions" | "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -95848,18 +102448,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). - * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - * - * `q=bug+defect+enhancement&repository_id=64778136` - * - * The labels that best match the query appear first in the search results. - */ "search/labels": { parameters: { query: { @@ -95869,14 +102457,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -95891,18 +102489,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). - * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: - * - * `q=tetris+language:assembly&sort=stars&order=desc` - * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - */ "search/repos": { parameters: { query: { @@ -95910,14 +102496,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -95931,30 +102527,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/github-ae@latest/articles/searching-topics/)" for a detailed list of qualifiers. - * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). - * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: - * - * `q=ruby+is:featured` - * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - */ "search/topics": { parameters: { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub AE. The REST API supports the same qualifiers as the web interface for GitHub AE. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/github-ae@latest/rest/search/search#constructing-a-search-query). */ q: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -95966,20 +102559,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/github-ae@latest/rest/search/search#text-match-metadata). - * - * For example, if you're looking for a list of popular users, you might try this query: - * - * `q=tom+repos:%3E42+followers:%3E1000` - * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/github-ae@latest/graphql/reference/queries#search)." - */ "search/users": { parameters: { query: { @@ -95987,14 +102566,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub AE. Default: [best match](https://docs.github.com/github-ae@latest/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -96008,20 +102597,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/github-ae@latest/rest/teams/teams#get-a-team-by-name) endpoint. - */ "teams/get-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -96029,44 +102621,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/github-ae@latest/rest/teams/teams#delete-a-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - */ "teams/delete-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/github-ae@latest/rest/teams/teams#update-a-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - */ "teams/update-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96077,18 +102663,18 @@ export interface operations { description?: string; /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -96108,12 +102694,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -96123,29 +102715,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/github-ae@latest/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/list-discussions-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -96153,20 +102746,15 @@ export interface operations { }; }; }; - /** - * Create a discussion (Legacy) - * @deprecated - * @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/github-ae@latest/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - */ "teams/create-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -96186,69 +102774,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/get-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/github-ae@latest/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/delete-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/github-ae@latest/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/update-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96263,36 +102856,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/list-discussion-comments-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -96300,21 +102898,17 @@ export interface operations { }; }; }; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @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/github-ae@latest/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://docs.github.com/github-ae@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/github-ae@latest/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-using-the-rest-api)." - */ "teams/create-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -96327,72 +102921,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/get-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/delete-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/github-ae@latest/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "teams/update-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -96405,36 +103007,39 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List team members (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/github-ae@latest/rest/teams/members#list-team-members) endpoint. - * - * Team members will include the members of child teams. - */ "teams/list-members-legacy": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -96443,126 +103048,123 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get team member (Legacy) - * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/get-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if user is not a member */ 404: { - content: never; - }; - }; - }; - /** - * Add team member (Legacy) - * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ 422: { - content: never; - }; - }; - }; - /** - * Remove team member (Legacy) - * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/remove-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team synchronization is setup */ 404: { - content: never; - }; - }; - }; - /** - * Get team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#get-team-membership-for-a-user) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/teams/teams#create-a-team). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/get-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; @@ -96570,27 +103172,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add or update team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - * - * **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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If 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. - */ "teams/add-or-update-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96607,72 +103199,82 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/github-ae@latest/rest/teams/members#remove-team-membership-for-a-user) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github-ae@latest/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 AE 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 AE](https://docs.github.com/github-ae@latest/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - */ "teams/remove-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/github-ae@latest/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ "teams/list-projects-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -96681,46 +103283,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/github-ae@latest/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - */ "teams/check-permissions-for-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/github-ae@latest/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - */ "teams/add-or-update-project-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96736,10 +103341,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -96751,49 +103362,53 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/github-ae@latest/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - */ "teams/remove-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List team repositories (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/github-ae@latest/rest/teams/teams#list-team-repositories) endpoint. - */ "teams/list-repos-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -96802,56 +103417,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a repository (Legacy) - * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/github-ae@latest/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `Accept` header: - */ "teams/check-permissions-for-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with extra repository information */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions (Legacy) - * @deprecated - * @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/github-ae@latest/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. - * - * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "teams/add-or-update-repo-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -96867,54 +103486,62 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/github-ae@latest/rest/teams/teams#remove-a-repository-from-a-team) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - */ "teams/remove-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/github-ae@latest/rest/teams/teams#list-child-teams) endpoint. - */ "teams/list-child-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -96925,16 +103552,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the authenticated user - * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - * - * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. - */ "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -96946,11 +103577,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Update the authenticated user - * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. - */ "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -96994,6 +103627,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["private-user"]; }; @@ -97005,22 +103641,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List followers of the authenticated user - * @description Lists the people following the authenticated user. - */ "users/list-followers-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -97031,22 +103670,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List the people the authenticated user follows - * @description Lists the people who the authenticated user follows. - */ "users/list-followed-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -97057,45 +103699,57 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Check if a person is followed by the authenticated user */ "users/check-person-is-followed-by-authenticated": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the person is followed by the authenticated user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. - */ "users/follow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -97103,20 +103757,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unfollow a user - * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. - */ "users/unfollow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -97124,22 +103782,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -97151,11 +103812,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -97169,6 +103832,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -97180,19 +103846,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/get-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -97203,20 +103873,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/delete-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -97225,28 +103899,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List app installations accessible to the user access token - * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * You must use a [user access token](https://docs.github.com/github-ae@latest/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You can find the permissions for the installation under the `permissions` key. - */ "apps/list-installations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -97260,31 +103931,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories accessible to the user access token - * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You must use a [user access token](https://docs.github.com/github-ae@latest/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * - * The access the user has to each repository is included in the hash under the `permissions` key. - */ "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -97299,68 +103967,58 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add a repository to an app installation - * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List user account issues assigned to the authenticated user - * @description 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 - * 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/github-ae@latest/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-authenticated-user": { parameters: { query?: { @@ -97374,20 +104032,30 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -97397,22 +104065,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key"][]; @@ -97424,11 +104095,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -97445,6 +104118,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -97456,19 +104132,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/get-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -97479,20 +104159,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - */ "users/delete-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -97500,24 +104184,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization memberships for the authenticated user - * @description Lists all of the authenticated user's organization memberships. - */ "orgs/list-memberships-for-authenticated-user": { parameters: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-membership"][]; @@ -97529,19 +104216,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization membership for the authenticated user - * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. - */ "orgs/get-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -97550,15 +104241,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization membership for the authenticated user - * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. - */ "orgs/update-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -97574,6 +104265,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -97583,22 +104277,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List user migrations - * @description Lists all migrations a user has started. - */ "migrations/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -97609,11 +104306,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Start a user migration - * @description Initiates the generation of a user migration archive. - */ "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -97656,8 +104355,8 @@ export interface operations { /** * @description Exclude attributes from the API response to improve performance * @example [ - * "repositories" - * ] + * "repositories" + * ] */ exclude?: "repositories"[]; repositories: string[]; @@ -97667,6 +104366,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -97677,65 +104379,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Download a user migration archive - * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - */ "migrations/get-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories for a user migration - * @description Lists all the repositories for this user migration. - */ "migrations/list-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -97744,26 +104433,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organizations for the authenticated user - * @description List organizations for the authenticated user. - * - * **OAuth scope requirements** - * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. - */ "orgs/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -97774,11 +104462,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -97798,6 +104488,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -97808,23 +104501,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repositories for the authenticated user - * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - */ "repos/list-for-authenticated-user": { parameters: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "internal" | "private"; - /** - * @description Comma-separated list of values. Can include: - * * `owner`: Repositories that are owned by the authenticated user. - * * `collaborator`: Repositories that the user has been added to as a collaborator. - * * `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: + * * `owner`: Repositories that are owned by the authenticated user. + * * `collaborator`: Repositories that the user has been added to as a collaborator. + * * `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. */ affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ type?: "all" | "owner" | "internal" | "private" | "member"; @@ -97832,15 +104517,26 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; + /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before-repo-date"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository"][]; }; @@ -97851,18 +104547,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a repository for the authenticated user - * @description Creates a new repository for the authenticated user. - * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository - * * `repo` scope to create a private repository - */ "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -97954,34 +104645,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -98006,6 +104697,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -98019,22 +104711,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository invitations for the authenticated user - * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. - */ "repos/list-invitations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -98046,17 +104741,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Decline a repository invitation */ "repos/decline-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -98064,17 +104766,24 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** Accept a repository invitation */ "repos/accept-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -98082,28 +104791,29 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List repositories starred by the authenticated user - * @description Lists repositories the authenticated user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-authenticated-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository"][]; @@ -98115,48 +104825,61 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Check if a repository is starred by the authenticated user - * @description Whether the authenticated user has starred the repository. - */ "activity/check-repo-is-starred-by-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if this repository is starred by you */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description Not Found if this repository is not starred by you */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "activity/star-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -98164,21 +104887,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unstar a repository for the authenticated user - * @description Unstar a repository that the authenticated user has previously starred. - */ "activity/unstar-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -98186,22 +104914,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories watched by the authenticated user - * @description Lists repositories the authenticated user is watching. - */ "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -98212,22 +104943,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/github-ae@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. - */ "teams/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-full"][]; @@ -98238,25 +104972,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List users - * @description Lists all users, in the order that they signed up on GitHub AE. This list includes personal user accounts and organization accounts. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. - */ "users/list": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -98265,25 +105000,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a user - * @description Provides publicly available information about someone with a GitHub account. - * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below" - * - * The `email` key in the following response is the publicly visible email address from your GitHub AE [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see [Authentication](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#authentication). - * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/github-ae@latest/rest/users/emails)". - */ "users/get-by-username": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -98293,72 +105026,86 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - */ "activity/list-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List organization events for the authenticated user - * @description This is the user's organization dashboard. You must be authenticated as the user to view this. - */ "activity/list-org-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List followers of a user - * @description Lists the people following the specified user. - */ "users/list-followers-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -98366,25 +105113,28 @@ export interface operations { }; }; }; - /** - * List the people a user follows - * @description Lists the people who the specified user follows. - */ "users/list-following-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -98392,45 +105142,59 @@ export interface operations { }; }; }; - /** Check if a user follows another user */ "users/check-following-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; target_user: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the user follows the target user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if the user does not follow the target user */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List gists for a user - * @description Lists public gists for the specified user: - */ "gists/list-for-user": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -98439,25 +105203,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List GPG keys for a user - * @description Lists the GPG keys for a user. This information is accessible by anyone. - */ "users/list-gpg-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -98465,17 +105232,6 @@ export interface operations { }; }; }; - /** - * Get contextual information for a user - * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: - * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` - */ "users/get-context-for-user": { parameters: { query?: { @@ -98484,13 +105240,20 @@ export interface operations { /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ subject_id?: string; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hovercard"]; }; @@ -98499,46 +105262,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user installation for the authenticated app - * @description Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-user-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List public keys for a user - * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - */ "users/list-public-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key-simple"][]; @@ -98546,27 +105314,28 @@ export interface operations { }; }; }; - /** - * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/github-ae@latest/articles/publicizing-or-concealing-organization-membership) for the specified user. - * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/github-ae@latest/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. - */ "orgs/list-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -98574,27 +105343,30 @@ export interface operations { }; }; }; - /** - * List user projects - * @description Lists projects for a user. - */ "projects/list-for-user": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -98603,10 +105375,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repositories for a user - * @description Lists public repositories for the specified user. - */ "repos/list-for-user": { parameters: { query?: { @@ -98616,18 +105384,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -98635,31 +105410,32 @@ export interface operations { }; }; }; - /** - * List repositories starred by a user - * @description Lists repositories a user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -98669,25 +105445,28 @@ export interface operations { }; }; }; - /** - * List repositories watched by a user - * @description Lists repositories a user is watching. - */ "activity/list-repos-watched-by-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -98695,19 +105474,15 @@ export interface operations { }; }; }; - /** - * Suspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/github-ae@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. - * - * You can suspend any user account except your own. - * - * 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 method](https://docs.github.com/github-ae@latest/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "enterprise-admin/suspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98720,19 +105495,22 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Unsuspend a user - * @description If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/github-ae@latest/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API. - */ "enterprise-admin/unsuspend-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98745,83 +105523,59 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the Zen of GitHub - * @description Get a random sentence from the Zen of GitHub - */ "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string; }; }; }; }; - /** - * Compare two commits - * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. - * - * 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. - * - * 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, 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)." - * - * 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 following fields are included in the `verification` object: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/github-ae@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; base: string; head: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index afa653c54..af090d1b1 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -3,172 +3,361 @@ * Do not make direct changes to the file. */ -/** OneOf type helpers */ -type Without = { [P in Exclude]?: never }; -type XOR = T | U extends object - ? (Without & U) | (Without & T) - : T | U; -type OneOf = T extends [infer Only] - ? Only - : T extends [infer A, infer B, ...infer Rest] - ? OneOf<[XOR, ...Rest]> - : never; - export interface paths { "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List global security advisories * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." + * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." */ get: operations["security-advisories/list-global-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a global security advisory * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. */ get: operations["security-advisories/get-global-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated app * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an app * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an app webhook * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for an app webhook * @description Returns a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List installations for the authenticated app * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. * - * The permissions the installation has are included under the `permissions` key. + * The permissions the installation has are included under the `permissions` key. */ get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an installation for the authenticated app * @description Enables an authenticated GitHub App to find an installation's information using the installation id. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. + * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. + * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Suspend an app installation * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. @@ -179,275 +368,589 @@ export interface paths { * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. */ delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ patch: operations["apps/reset-token"]; + trace?: never; }; "/applications/{client_id}/token/scoped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a scoped access token * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. + * which repositories the token can access and which permissions are granted to the + * token. * - * Invalid tokens will return `404 NOT FOUND`. + * Invalid tokens will return `404 NOT FOUND`. * - * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. + * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ post: operations["apps/scope-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/assignments/{assignment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an assignment * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ get: operations["classroom/get-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/assignments/{assignment_id}/accepted_assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List accepted assignments for an assignment * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ get: operations["classroom/list-accepted-assigments-for-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/assignments/{assignment_id}/grades": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get assignment grades * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ get: operations["classroom/get-assignment-grades"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/classrooms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List classrooms * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. */ get: operations["classroom/list-classrooms"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/classrooms/{classroom_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a classroom * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. */ get: operations["classroom/get-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/classrooms/{classroom_id}/assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignments for a classroom * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. */ get: operations["classroom/list-assignments-for-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get emojis * @description Lists all the emojis available to use on GitHub. */ get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a summary of Copilot usage for enterprise members * @description **Note**: This endpoint is in beta and is subject to change. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, + * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. + * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + * metrics for the enterprise. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. */ get: operations["copilot/usage-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. * - * The authenticated user must be a member of the enterprise to use this endpoint. + * The authenticated user must be a member of the enterprise to use this endpoint. * - * 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)." + * 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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ get: operations["dependabot/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/enterprises/{enterprise}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is 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). + * Alerts are only returned for organizations in the enterprise for which the authenticated user is 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). * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * The authenticated user must be a member of the enterprise in order to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. */ get: operations["secret-scanning/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public events * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. */ get: operations["activity/list-public-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get feeds * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * - * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + * * **Timeline**: The GitHub global public timeline + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * * **Current user public**: The public timeline for the authenticated user + * * **Current user**: The private timeline for the authenticated user + * * **Current user actor**: The private timeline for activity created by the authenticated user + * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. + * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. + * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public gists * @description List public gists sorted by most recently updated to least recently updated. * - * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. + * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List starred gists * @description List the authenticated user's starred gists: */ get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist * @description Gets a specified gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @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. */ patch: operations["gists/update"]; + trace?: never; }; "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gist comments * @description Lists the comments on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist comment * @description Gets a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update-comment"]; + trace?: never; }; "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist commits */ get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List gist forks */ get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a gist is starred */ get: operations["gists/check-is-starred"]; /** @@ -455,173 +958,418 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; + post?: never; /** Unstar a gist */ delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gist revision * @description Gets a specified gist revision. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a gitignore template * @description Get the content of a gitignore template. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. + * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. */ get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. + * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issues assigned to the authenticated user * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. + * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not + * necessarily assigned to you. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Render a Markdown document */ post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a subscription plan for an account * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List plans * @description Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List accounts for a plan * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/stubbed/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a subscription plan for an account (stubbed) * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/get-subscription-plan-for-account-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/stubbed/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List plans (stubbed) * @description Lists all plans that are part of your GitHub Marketplace listing. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-plans-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List accounts for a plan (stubbed) * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. + * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. */ get: operations["apps/list-accounts-for-plan-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub meta information * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." * - * The API's response also includes a list of GitHub's domain names. + * The API's response also includes a list of GitHub's domain names. * - * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. + * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/networks/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a network of repositories */ get: operations["activity/list-public-events-for-repo-network"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. @@ -632,180 +1380,301 @@ export interface paths { * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread * @description Gets information about a notification thread. */ get: operations["activity/get-thread"]; + put?: never; + post?: never; /** * Mark a thread as done * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. */ delete: operations["activity/mark-thread-as-done"]; + options?: never; + head?: never; /** * Mark a thread as read * @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. */ patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a thread subscription for the authenticated user * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription). * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. + * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. + * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. + * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Octocat * @description Get the octocat as ASCII art */ get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations * @description Lists all organizations, in the order that they were created. * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * - * To see the full details about an organization, the authenticated user must be an organization owner. + * To see the full details about an organization, the authenticated user must be an organization owner. * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. * - * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. + * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ get: operations["orgs/get"]; + put?: never; + post?: never; /** * Delete an organization * @description Deletes an organization and all its repositories. * - * The organization login will be unavailable for 90 days after deletion. + * The organization login will be unavailable for 90 days after deletion. * - * Please review the Terms of Service regarding account deletion before using this endpoint: + * Please review the Terms of Service regarding account deletion before using this endpoint: * - * https://docs.github.com/site-policy/github-terms/github-terms-of-service + * https://docs.github.com/site-policy/github-terms/github-terms-of-service */ delete: operations["orgs/delete"]; + options?: never; + head?: never; /** * Update an organization * @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). * - * Updates the organization's profile and member privileges. + * Updates the organization's profile and member privileges. * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ patch: operations["orgs/update"]; + trace?: never; }; "/orgs/{org}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for an organization * @description 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/cache/usage-by-repository": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their 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. + * 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. * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["oidc/update-oidc-custom-sub-template-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories enabled for GitHub Actions in an organization * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** @@ -813,477 +1682,746 @@ export interface paths { * @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)." * * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions and reusable workflows for an organization * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions and reusable workflows for an organization * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for an organization * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[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)." + * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + * "[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)." * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description 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 - * "[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)." + * can submit approving pull request reviews. For more information, see + * "[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)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the organization. + * The authenticated user must have admin access to the organization. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** * Set custom labels for a self-hosted runner for an organization * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. + * self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization * @description Adds custom labels to a self-hosted runner configured in an organization. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** * Remove all custom labels from a self-hosted runner for an organization * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. + * organization. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an organization * @description Remove a custom label from a self-hosted runner configured - * in an organization. Returns the remaining labels from the runner. + * in an organization. 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. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * The authenticated user must have collaborator access to a repository to create, update, or read secrets * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to + * use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. For more information about setting the visibility, see [Create or + * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization variables * @description Lists all organization variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-variables"]; + put?: never; /** * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-org-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization variable * @description Gets a specific variable in an organization. * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-variable"]; + put?: never; + post?: never; /** * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-variable"]; + options?: never; + head?: never; /** * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ patch: operations["actions/update-org-variable"]; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization variable * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. + * that is available to selected repositories. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-variable"]; /** * Set selected repositories for an organization variable * @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`. + * to selected repositories. Organization variables that are available to selected + * repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-variable"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization variable * @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`. + * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-variable"]; + post?: never; /** * Remove selected repository from an organization variable * @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`. + * available to selected repositories. Organization variables that are available to + * selected repositories have their `visibility` field set to `selected`. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-variable"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users blocked by an organization * @description List the users blocked by an organization. */ get: operations["orgs/list-blocked-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is blocked by an organization * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. @@ -1294,51 +2432,103 @@ export interface paths { * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. */ put: operations["orgs/block-user"]; + post?: never; /** * Unblock a user from an organization * @description Unblocks the given user on behalf of the specified organization. */ delete: operations["orgs/unblock-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-in-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-codespaces-access"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/access/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add users to Codespaces access for an organization * @deprecated * @description Codespaces for the specified users will be billed to the organization. * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + * To use this endpoint, the access settings for the organization must be set to `selected_members`. + * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/set-codespaces-access-users"]; /** @@ -1346,540 +2536,900 @@ export interface paths { * @deprecated * @description Codespaces for the specified users will no longer be billed to the organization. * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." + * To use this endpoint, the access settings for the organization must be set to `selected_members`. + * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-codespaces-access-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets an organization development environment secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes an organization development environment secret using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization development environment secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization development environment secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Copilot seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * Gets information about an organization's Copilot subscription, including seat breakdown + * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. + * Only organization owners can configure and view details about the organization's Copilot Business subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing/seats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List all Copilot seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing/selected_teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add teams to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Purchases a GitHub Copilot seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Cancels the Copilot seat assignment for all members of each team specified. + * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/billing/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add users to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. + * Cancels the Copilot seat assignment for each user specified. + * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners can configure GitHub Copilot in their organization. + * Only organization owners can configure GitHub Copilot in their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a summary of Copilot usage for organization members * @description **Note**: This endpoint is in beta and is subject to change. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. + * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + * Copilot usage metrics. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. */ get: operations["copilot/usage-metrics-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization secrets * @description Lists all secrets available in an organization without revealing their - * encrypted values. + * encrypted values. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access + * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization + * permission to use this endpoint. * - * #### Example encrypting a secret using Node.js + * #### Example encrypting a secret using Node.js * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. + * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. * - * ``` - * const sodium = require('tweetsodium'); + * ``` + * const sodium = require('tweetsodium'); * - * const key = "base64-encoded-public-key"; - * const value = "plain-text-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'); + * // Convert the message and key to Uint8Array's (Buffer implements that interface) + * const messageBytes = Buffer.from(value); + * const keyBytes = Buffer.from(key, 'base64'); * - * // Encrypt using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); + * // Encrypt using LibSodium. + * const encryptedBytes = sodium.seal(messageBytes, keyBytes); * - * // Base64 the encrypted secret - * const encrypted = Buffer.from(encryptedBytes).toString('base64'); + * // Base64 the encrypted secret + * const encrypted = Buffer.from(encryptedBytes).toString('base64'); * - * console.log(encrypted); - * ``` + * console.log(encrypted); + * ``` * * - * #### Example encrypting a secret using Python + * #### Example encrypting a secret using Python * - * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. + * Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3. * - * ``` - * from base64 import b64encode - * from nacl import encoding, public + * ``` + * from base64 import b64encode + * from nacl import encoding, public * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` + * def encrypt(public_key: str, secret_value: str) -> str: + * """Encrypt a Unicode string using the public key.""" + * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) + * sealed_box = public.SealedBox(public_key) + * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) + * return b64encode(encrypted).decode("utf-8") + * ``` * - * #### Example encrypting a secret using C# + * #### Example encrypting a secret using C# * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. + * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); + * ``` + * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); + * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); + * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` + * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); + * ``` * - * #### Example encrypting a secret using Ruby + * #### Example encrypting a secret using Ruby * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. + * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. * - * ```ruby - * require "rbnacl" - * require "base64" + * ```ruby + * require "rbnacl" + * require "base64" * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) + * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") + * public_key = RbNaCl::PublicKey.new(key) * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") + * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) + * encrypted_secret = box.encrypt("my_secret") * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` + * # Print the base64 encoded secret + * puts Base64.strict_encode64(encrypted_secret) + * ``` */ put: operations["dependabot/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for an organization secret * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. + * for repository access to a secret is set to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public organization events */ get: operations["activity/list-public-org-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/failed_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List failed organization invitations * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ get: operations["orgs/list-failed-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization webhooks * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description Create a hook that posts payloads in JSON format. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization webhook * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** * Delete an organization webhook * @description You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping an organization webhook * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - * to be sent to the hook. + * to be sent to the hook. * - * You must be an organization owner to use this endpoint. + * You must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization installation for the authenticated app * @description Enables an authenticated GitHub App to find the organization's installation information. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations for an organization * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. + * all GitHub Apps installed on repositories in the organization. * - * The authenticated user must be an organization owner to use this endpoint. + * The authenticated user must be an organization owner to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get interaction restrictions for an organization * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. @@ -1890,122 +3440,261 @@ export interface paths { * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ put: operations["interactions/set-restrictions-for-org"]; + post?: never; /** * Remove interaction restrictions for an organization * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ delete: operations["interactions/remove-restrictions-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pending organization invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ get: operations["orgs/list-pending-invitations"]; + put?: never; /** * Create an organization invitation * @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. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["orgs/create-invitation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Cancel an organization invitation * @description 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/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ delete: operations["orgs/cancel-invitation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/invitations/{invitation_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization invitation teams * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ get: operations["orgs/list-invitation-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization issues assigned to the authenticated user * @description List issues in an organization assigned to the authenticated user. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. */ delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-codespaces-for-user-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a codespace from the organization * @description Deletes a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-from-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Stop a codespace for an organization user * @description Stops a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/stop-in-organization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/members/{username}/copilot": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get Copilot seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * Organization owners can view GitHub Copilot seat assignment details for members in their organization. * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. @@ -2015,498 +3704,921 @@ export interface paths { * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. + * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. + * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. * - * **Rate limits** + * **Rate limits** * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. + * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. */ delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization migrations * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). * - * A list of `repositories` is only returned for export migrations. + * A list of `repositories` is only returned for export migrations. */ get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. */ post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization migration status * @description Fetches the status of a migration. * - * The `state` of a migration can be one of the following values: + * The `state` of a migration can be one of the following values: * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. + * * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-fine-grained-permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization fine-grained permissions for an organization * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-organization-fine-grained-permissions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all organization roles for an organization * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-roles"]; + put?: never; /** * Create a custom organization role * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-organization-role"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a team * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Assign an organization role to a team * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["orgs/assign-team-to-org-role"]; + post?: never; /** * Remove an organization role from a team * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a user * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Assign an organization role to a user * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["orgs/assign-user-to-org-role"]; + post?: never; /** * Remove an organization role from a user * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization role * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/get-org-role"]; + put?: never; + post?: never; /** * Delete a custom organization role. * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-organization-role"]; + options?: never; + head?: never; /** * Update a custom organization role * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * - * To use this endpoint, the authenticated user must be one of: + * To use this endpoint, the authenticated user must be one of: * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/patch-custom-organization-role"]; + trace?: never; }; "/orgs/{org}/organization-roles/{role_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams that are assigned to an organization role * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization. + * To use this endpoint, you must be an administrator for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/organization-roles/{role_id}/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users that are assigned to an organization role * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization. + * To use this endpoint, you must be an administrator for the organization. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Convert an organization member to outside collaborator * @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)." */ put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for an organization * @description Lists packages in an organization readable by the user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/list-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for an organization * @description Gets a specific package in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-package-for-organization"]; + put?: never; + post?: never; /** * Delete a package for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ delete: operations["packages/delete-package-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for an organization * @description Restores an entire package in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ post: operations["packages/restore-package-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. 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)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. 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)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for an organization * @description Gets a specific package version in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-package-version-for-organization"]; + put?: never; + post?: never; /** * Delete package version for an organization * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ delete: operations["packages/delete-package-version-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for an organization * @description Restores a specific package version in an organization. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ post: operations["packages/restore-package-version-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List requests to access organization resources with fine-grained personal access tokens * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-requests"]; + put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-requests-in-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review a request to access organization resources with a fine-grained personal access token * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories requested to be accessed by a fine-grained personal access token * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-request-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List fine-grained personal access tokens with access to organization resources * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grants"]; + put?: never; /** * Update the access to organization resources via fine-grained personal access tokens * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-accesses"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Update the access a fine-grained personal access token has to organization resources * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-access"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories a fine-grained personal access token has access to * @description Lists the repositories a fine-grained personal access token has access to. * - * Only GitHub Apps can use this endpoint. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization projects * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-org"]; + put?: never; /** * Create an organization project * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/properties/schema": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. - * Organization members can read these properties. + * Organization members can read these properties. */ get: operations["orgs/get-all-custom-properties"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ patch: operations["orgs/create-or-update-custom-properties"]; + trace?: never; }; "/orgs/{org}/properties/schema/{custom_property_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. - * Organization members can read these properties. + * Organization members can read these properties. */ get: operations["orgs/get-custom-property"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ put: operations["orgs/create-or-update-custom-property"]; + post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ delete: operations["orgs/remove-custom-property"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom property values for organization repositories * @description Lists organization repositories with all of their custom property values. - * Organization members can read these properties. + * Organization members can read these properties. */ get: operations["orgs/list-custom-properties-values-for-repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for organization repositories * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. - * Each target repository will have its custom property values updated to match the values provided in the request. + * Each target repository will have its custom property values updated to match the values provided in the request. * - * A maximum of 30 repositories can be updated in a single request. + * A maximum of 30 repositories can be updated in a single request. * - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + trace?: never; }; "/orgs/{org}/public_members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. */ get: operations["orgs/list-public-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/public_members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check public organization membership for a user * @description Check if the provided user is a public member of the organization. @@ -2516,60 +4628,121 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; + post?: never; /** * Remove public organization membership for the authenticated user * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization repositories * @description 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)." + * **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: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all organization repository rulesets * @description Get all the repository rulesets for an organization. */ get: operations["repos/get-org-rulesets"]; + put?: never; /** * Create an organization repository ruleset * @description Create a repository ruleset for an organization. */ post: operations["repos/create-org-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization rule suites * @description Lists suites of rule evaluations at the organization level. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ get: operations["repos/get-org-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization rule suite * @description Gets information about a suite of rule evaluations from within an organization. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ get: operations["repos/get-org-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. @@ -2580,1429 +4753,2651 @@ export interface paths { * @description Update a ruleset for an organization. */ put: operations["repos/update-org-ruleset"]; + post?: never; /** * Delete an organization repository ruleset * @description Delete a ruleset for an organization. */ delete: operations["repos/delete-org-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository security advisories for an organization * @description Lists repository security advisories for an organization. * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ get: operations["security-advisories/list-org-repository-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List security manager teams * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-security-manager-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/security-managers/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a security manager team * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["orgs/add-security-manager-team"]; + post?: never; /** * Remove a security manager team * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." * - * The authenticated user must be an administrator for the organization to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-security-manager-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions billing for an organization * @description Gets the summary of the free and paid GitHub Actions minutes used. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Packages billing for an organization * @description Gets the free and paid storage used for GitHub Packages in gigabytes. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/settings/billing/shared-storage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get shared storage billing for an organization * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a summary of Copilot usage for a team * @description **Note**: This endpoint is in beta and is subject to change. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + * See the response schema tab for detailed metrics definitions. * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. + * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, + * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, + * they must have telemetry enabled in their IDE. * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. + * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. */ get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ get: operations["teams/list"]; + put?: never; /** * Create a team * @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)." * - * 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/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team by name * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ patch: operations["teams/update-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions * @description List all discussions on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-in-org"]; + put?: never; /** * Create a discussion * @description Creates a new discussion post on a team's page. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion * @description Get a specific discussion on a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-in-org"]; + put?: never; + post?: never; /** * Delete a discussion * @description Delete a discussion from a team's page. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-in-org"]; + options?: never; + head?: never; /** * Update a discussion * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments * @description List all comments on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-in-org"]; + put?: never; /** * Create a discussion comment * @description Creates a new comment on a team discussion. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * **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`. + * **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`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment * @description Get a specific comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-in-org"]; + put?: never; + post?: never; /** * Delete a discussion comment * @description Deletes a comment on a team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-in-org"]; + options?: never; + head?: never; /** * Update a discussion comment * @description Edits the body text of a discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-in-org"]; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; + put?: never; /** * Create reaction for a team discussion comment * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; + put?: never; /** * Create reaction for a team discussion * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pending team invitations * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ get: operations["teams/list-pending-invitations-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members * @description Team members will include the members of child teams. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user * @description Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description 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. + * 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. * - * **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:** 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. + * 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. * - * If 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. + * If 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. * - * **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}`. + * **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}`. */ put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @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. * - * 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. + * 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. * - * **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:** 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}`. + * **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}`. */ delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects * @description Lists the organization projects for a team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. */ get: operations["teams/list-projects-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ get: operations["teams/check-permissions-for-project-in-org"]; /** * Add or update team project permissions * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ put: operations["teams/add-or-update-project-permissions-in-org"]; + post?: never; /** * Remove a project from a team * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. */ delete: operations["teams/remove-project-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories * @description Lists a team's repositories visible to the authenticated user. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. + * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * **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}`. + * **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/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams * @description Lists the child teams of the team specified by `{team_slug}`. * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/orgs/{org}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature for an organization * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/cards/{card_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project card * @description Gets information about a project card. */ get: operations["projects/get-card"]; + put?: never; + post?: never; /** * Delete a project card * @description Deletes a project card */ delete: operations["projects/delete-card"]; + options?: never; + head?: never; /** Update an existing project card */ patch: operations["projects/update-card"]; + trace?: never; }; "/projects/columns/cards/{card_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project card */ post: operations["projects/move-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project column * @description Gets information about a project column. */ get: operations["projects/get-column"]; + put?: never; + post?: never; /** * Delete a project column * @description Deletes a project column. */ delete: operations["projects/delete-column"]; + options?: never; + head?: never; /** Update an existing project column */ patch: operations["projects/update-column"]; + trace?: never; }; "/projects/columns/{column_id}/cards": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project cards * @description Lists the project cards in a project. */ get: operations["projects/list-cards"]; + put?: never; /** Create a project card */ post: operations["projects/create-card"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/columns/{column_id}/moves": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Move a project column */ post: operations["projects/move-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a project * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/get"]; + put?: never; + post?: never; /** * Delete a project * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. */ delete: operations["projects/delete"]; + options?: never; + head?: never; /** * Update a project * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ patch: operations["projects/update"]; + trace?: never; }; "/projects/{project_id}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project collaborators * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. */ get: operations["projects/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add project collaborator * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. */ put: operations["projects/add-collaborator"]; + post?: never; /** * Remove user as a collaborator * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. */ delete: operations["projects/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get project permission for a user * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. */ get: operations["projects/get-permission-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/projects/{project_id}/columns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List project columns * @description Lists the project columns in a project. */ get: operations["projects/list-columns"]; + put?: never; /** * Create a project column * @description Creates a new project column. */ post: operations["projects/create-column"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rate limit status for the authenticated user * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." + * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." + * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. + * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository * @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. * - * **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)." + * **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: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. + * If an organization owner has configured the organization to prevent members from deleting organization-owned + * repositories, you will get a `403 Forbidden` response. * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. */ patch: operations["repos/update"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List artifacts for a repository * @description Lists all artifacts for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an artifact * @description Gets a specific artifact for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download an artifact * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. + * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. - * 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. + * 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. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-list"]; + put?: never; + post?: never; /** * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a job for a workflow run * @description Gets a specific job in a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. + * for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization secrets * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/organization-variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository organization variables * @description Lists all organization variables shared with a repository. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-variables"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the level of access for workflows outside of the repository * @description 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 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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-workflow-access-to-repository"]; /** * Set the level of access for workflows outside of the repository * @description 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 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)". * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-workflow-access-to-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get allowed actions and reusable workflows for a repository * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions and reusable workflows for a repository * @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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default workflow permissions for a repository * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For 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)." + * as well as if GitHub Actions can submit approving pull request reviews. + * For 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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For 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)." + * can submit approving pull request reviews. + * For 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)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * The authenticated user must have admin access to the repository. + * The authenticated user must have admin access to the repository. * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * ``` - * ./config.sh remove --token TOKEN - * ``` + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** * Set custom labels for a self-hosted runner for a repository * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. + * self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository * @description Adds custom labels to a self-hosted runner configured in a repository. * - * Authenticated users must have admin access to the organization to use this endpoint. + * Authenticated users must have admin access to the organization to use this endpoint. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** * Remove all custom labels from a self-hosted runner for a repository * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. + * repository. Returns the remaining read-only labels from the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for a repository * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. + * in a repository. Returns the remaining labels from the runner. * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. + * This endpoint returns a `404 Not Found` status if the custom label is not + * present on the runner. * - * Authenticated users must have admin access to the repository to use this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a repository * @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/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. + * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run * @description Gets a specific workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Deletes a specific workflow run. * - * Anyone with write access to the repository can use this endpoint. + * Anyone with write access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the review history for a workflow run * @description Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-reviews-for-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/approve-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow run artifacts * @description Lists artifacts for a workflow run. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow run attempt * @description Gets a specific workflow run attempt. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run attempt * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + * **Note:** GitHub Apps can only review their own custom deployment protection rules. + * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ post: operations["actions/review-custom-gates-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Force cancel a workflow run * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. - * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/force-cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. + * `Location:` in the response header to find the URL for the download. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @description Deletes all logs for a workflow run. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-pending-deployments-for-run"]; + put?: never; /** * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/review-pending-deployments-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a workflow * @description Re-runs your workflow run using its `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run failed jobs from a workflow run * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow-failed-jobs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get workflow run usage * @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)". * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-run-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository variables * @description Lists all repository variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-variables"]; + put?: never; /** * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-repo-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository variable * @description Gets a specific variable in a repository. * - * The authenticated user must have collaborator access to the repository to use this endpoint. + * The authenticated user must have collaborator access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-variable"]; + put?: never; + post?: never; /** * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-variable"]; + options?: never; + head?: never; /** * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-repo-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository workflows * @description Lists the workflows in a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a workflow * @description Gets a specific workflow. You can replace `workflow_id` with the workflow - * file name. For example, you could use `main.yaml`. + * file name. For example, you could use `main.yaml`. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Disable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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`. * - * You 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)." + * You 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)." * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Enable a workflow * @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`. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List workflow runs for a workflow * @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/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint + * Anyone with read access to the repository can use this endpoint * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get workflow usage * @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)". * - * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * 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. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["actions/get-workflow-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository activities * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * - * For more information about viewing repository activity, - * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." + * For more information about viewing repository activity, + * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." */ get: operations["repos/list-activities"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned * @description Checks if a user has permission to be assigned to an issue in this repository. * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. + * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. * - * Otherwise a `404` status code is returned. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all autolinks of a repository * @description Gets all autolinks that are configured for a repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an autolink reference of a repository * @description This returns a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * - * Information about autolinks are only available to repository administrators. + * Information about autolinks are only available to repository administrators. */ delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if automated security fixes are enabled for a repository * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". @@ -4013,21 +7408,58 @@ export interface paths { * @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)". */ put: operations["repos/enable-automated-security-fixes"]; + post?: never; /** * Disable 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/articles/configuring-automated-security-fixes)". */ delete: operations["repos/disable-automated-security-fixes"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List branches */ get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a branch */ get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get branch protection * @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. @@ -4037,106 +7469,161 @@ export interface paths { * Update branch protection * @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. * - * Protecting a branch requires admin or owner permissions to the repository. + * Protecting a branch requires admin or owner permissions to the repository. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. + * **Note**: The list of users, apps, and teams in total is limited to 100 items. */ put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @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. */ delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get admin branch protection * @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. */ get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @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. * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @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. * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get pull request review protection * @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. */ get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @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. */ delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @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. * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. */ patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit signature protection * @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. * - * When 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. + * When 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. * - * **Note**: You must enable branch protection to require signed commits. + * **Note**: You must enable branch protection to require signed commits. */ get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @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. * - * When 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. + * When 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. */ post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @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. * - * When 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. + * When 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. */ delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get status checks protection * @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. */ get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @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. */ delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @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. * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. + * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ patch: operations["repos/update-status-check-protection"]; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all status check contexts * @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. @@ -4157,1946 +7644,3288 @@ export interface paths { * @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. */ delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get 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. * - * Lists who has access to this protected branch. + * Lists who has access to this protected branch. * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete 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. * - * Disables the ability to restrict who can push to this branch. + * Disables the ability to restrict who can push to this branch. */ delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get apps with access to the protected branch * @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. * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * 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. * - * 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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * 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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * 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. * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * 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. * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get teams with access to the protected branch * @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. * - * Lists the teams who have push access to this branch. The list includes child teams. + * Lists the teams who have push access to this branch. The list includes child teams. */ get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces 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. + * Replaces 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. */ put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified teams push access for this branch. You can also give push access to child teams. + * Grants the specified teams push access for this branch. You can also give push access to child teams. */ post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. + * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get users with access to the protected branch * @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. * - * Lists the people who have push access to this branch. + * Lists the people who have push access to this branch. */ get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user 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. * - * Replaces 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. + * Replaces 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. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ put: operations["repos/set-user-access-restrictions"]; /** * Add user 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. * - * Grants the specified people push access for this branch. + * Grants the specified people push access for this branch. * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ post: operations["repos/add-user-access-restrictions"]; /** * Remove user 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. * - * Removes the ability of a user to push to this branch. + * Removes the ability of a user to push to this branch. * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | + * | Type | Description | + * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | + * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/branches/{branch}/rename": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rename a branch * @description Renames a branch in a repository. * - * **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)". + * **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)". * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ post: operations["repos/rename-branch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check run * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. */ post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check run * @description Gets a single check run using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ patch: operations["checks/update"]; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check run annotations * @description Lists annotations for a check run using the annotation `id`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a check suite * @description Gets a single check suite using its `id`. * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs in a check suite * @description Lists check runs for a check suite using its `id`. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning alerts for a repository * @description Lists all open code scanning alerts for the default branch (usually `main` - * or `master`). 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. + * or `master`). 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. * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch or for the specified Git reference - * (if you used `ref` in the request). + * The response includes a `most_recent_instance` object. + * This provides details of the most recent instance of this alert + * for the default branch or for the specified Git reference + * (if you used `ref` in the request). */ get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning alert * @description Gets a single code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List code scanning analyses for a repository * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. + * starting with the most recent. + * The response is paginated and you can use the `page` and `per_page` parameters + * to list the analyses you're interested in. + * By default 30 analyses are listed per page. * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * **Deprecation notice**: + * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. + * The default JSON response contains fields that describe the analysis. + * This includes the Git reference and commit SHA to which the analysis relates, + * the datetime of the analysis, the name of the code scanning tool, + * and the number of alerts. * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. + * The `rules_count` field in the default response give the number of rules + * that were run in the analysis. + * For very old analyses this data is not available, + * and `0` is returned in this field. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * You can delete one analysis at a time. + * To delete a series of analyses, start with the most recent analysis and work backwards. + * Conceptually, the process is similar to the undo function in a text editor. + * + * When you list the analyses for a repository, + * one or more will be identified as deletable in the response: + * + * ``` + * "deletable": true + * ``` + * + * An analysis is deletable when it's the most recent in a set of analyses. + * Typically, a repository will have multiple sets of analyses + * for each enabled code scanning tool, + * where a set is determined by a unique combination of analysis values: + * + * * `ref` + * * `tool` + * * `category` + * + * If you attempt to delete an analysis that is not the most recent in a set, + * you'll get a 400 response with the message: + * + * ``` + * Analysis specified is not deletable. + * ``` + * + * The response from a successful `DELETE` operation provides you with + * two alternative URLs for deleting the next analysis in the set: + * `next_analysis_url` and `confirm_delete_url`. + * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis + * in a set. This is a useful option if you want to preserve at least one analysis + * for the specified tool in your repository. + * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. + * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` + * in the 200 response is `null`. + * + * As an example of the deletion process, + * let's imagine that you added a workflow that configured a particular code scanning tool + * to analyze the code in a repository. This tool has added 15 analyses: + * 10 on the default branch, and another 5 on a topic branch. + * You therefore have two separate sets of analyses for this tool. + * You've now decided that you want to remove all of the analyses for the tool. + * To do this you must make 15 separate deletion requests. + * To start, you must find an analysis that's identified as deletable. + * Each set of analyses always has one that's identified as deletable. + * Having found the deletable analysis for one of the two sets, + * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. + * Then repeat the process for the second set. + * The procedure therefore consists of a nested loop: + * + * **Outer loop**: + * * List the analyses for the repository, filtered by tool. + * * Parse this list to find a deletable analysis. If found: + * + * **Inner loop**: + * * Delete the identified analysis. + * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. + * + * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/list-codeql-databases"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a CodeQL database for a repository * @description Gets a CodeQL database for a language in a repository. * - * By default this endpoint returns JSON metadata about the CodeQL database. To - * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure - * your HTTP client is configured to follow redirects or use the `Location` header - * to make a second request to get the redirect URL. + * By default this endpoint returns JSON metadata about the CodeQL database. To + * download the CodeQL database binary content, set the `Accept` header of the request + * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure + * your HTTP client is configured to follow redirects or use the `Location` header + * to make a second request to get the redirect URL. * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-codeql-database"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/default-setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-default-setup"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ patch: operations["code-scanning/update-default-setup"]; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." + * There are two places where you can upload code scanning results. + * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." + * - 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)." * - * You 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: + * You 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: * - * ``` - * gzip -c analysis-data.sarif | base64 -w0 - * ``` + * ``` + * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." + * SARIF 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. | + * | **SARIF data** | **Maximum values** | **Additional limits** | + * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| + * | Runs per file | 20 | | + * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * The `202 Accepted` response includes an `id` value. + * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. + * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List CODEOWNERS errors * @description List any syntax errors that are detected in the CODEOWNERS - * file. + * file. * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." + * For more information about the correct CODEOWNERS syntax, + * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces in a repository for the authenticated user * @description Lists the codespaces associated to a specified repository and the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-in-repository-for-authenticated-user"]; + put?: never; /** * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-repo-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/devcontainers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List devcontainer configurations in a repository for the authenticated user * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files - * specify launchpoint configurations for codespaces created within the repository. + * specify launchpoint configurations for codespaces created within the repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List available machine types for a repository * @description List the machine types available for a given repository based on its configuration. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/repo-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/new": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get default attributes for a codespace * @description Gets the default attributes for codespaces created by the user with the repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/permissions_check": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if permissions defined by a devcontainer have been accepted by the authenticated user * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/check-permissions-for-devcontainer"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all development environment secrets available in a repository without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. + * encrypt a secret before you can create or update secrets. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository development environment secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["codespaces/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["codespaces/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is a repository collaborator * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. + * The authenticated user must have push access to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/check-collaborator"]; /** * Add a repository collaborator * @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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * 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/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: + * 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: * - * ``` - * Cannot assign {member} permission of {role name} - * ``` + * ``` + * Cannot assign {member} permission of {role name} + * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). + * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * - * **Updating an existing collaborator's permission level** + * **Updating an existing collaborator's permission level** * - * The 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. + * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. * - * **Rate limits** + * **Rate limits** * - * You 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. + * You 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. */ put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. + * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages + * This endpoint also: + * - Cancels any outstanding invitations + * - Unasigns the user from any issues + * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. + * - Unstars the repository + * - Updates access permissions to packages * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. + * Removing a user as a collaborator has the following effects on forks: + * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. + * - If the user had their own fork of the repository, the fork will be deleted. + * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. + * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". + * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository permissions for a user * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * permissions are `admin`, `write`, `read`, and `none`. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the + * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. */ get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments for a repository * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit comment * @description Gets a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["repos/update-commit-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). + * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List branches for HEAD commit * @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. * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. + * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit comments * @description Lists the comments for a specified commit. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests associated with a commit * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. + * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * - * **Signature verification object** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check runs for a Git reference * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List check suites for a Git reference * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the combined status for a specific reference * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. * * - * Additionally, a combined `state` is returned. The `state` is one of: + * Additionally, a combined `state` is returned. The `state` is one of: * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` + * * **failure** if any of the contexts report as `error` or `failure` + * * **pending** if there are no statuses or a context is `pending` + * * **success** if the latest status for all contexts is `success` */ get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commit statuses for a reference * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. + * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/community/profile": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get community profile metrics * @description Returns all community profile metrics for a repository. The repository 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, - * README, and CONTRIBUTING files. + * 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, + * README, and CONTRIBUTING files. * - * The `health_percentage` score is defined as a percentage of how many of - * the recommended community health files are present. For more information, see - * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." + * The `health_percentage` score is defined as a percentage of how many of + * the recommended community health files are present. For more information, see + * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." * - * `content_reports_enabled` is only returned for organization-owned repositories. + * `content_reports_enabled` is only returned for organization-owned repositories. */ get: operations["repos/get-community-profile-metrics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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)." * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * - * 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 API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. + * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. * - * **Working with large comparisons** + * **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: + * 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. + * - 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. * - * 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)." + * 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)." * - * **Signature verification object** + * **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 `verification` object includes the following fields: * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits-with-basehead"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository content * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * - * **Notes**: + * **Notes**: * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. + * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. + * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. + * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository contributors * @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. * - * 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. + * 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. */ get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List Dependabot alerts for a repository * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a Dependabot alert * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["dependabot/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a Dependabot alert * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["dependabot/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted - * values. + * values. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository public key * @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. + * encrypt a secret before you can create or update secrets. Anyone with read access + * to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ get: operations["dependabot/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["dependabot/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["dependabot/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a diff of the dependencies between commits * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */ get: operations["dependency-graph/diff-range"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/sbom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Export a software bill of materials (SBOM) for a repository. * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. */ get: operations["dependency-graph/export-sbom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dependency-graph/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a snapshot of dependencies for a repository * @description Create a new snapshot of a repository's dependencies. * - * The authenticated user must have access to the repository. + * The authenticated user must have access to the repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["dependency-graph/create-repository-snapshot"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them - * before we merge a pull request. + * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them + * before we merge a pull request. * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. + * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have + * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter + * makes it easier to track which environments have requested deployments. The default environment is `production`. * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. + * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If + * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, + * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will + * return a failure response. * - * By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. + * By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` + * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to + * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do + * not require any contexts or create any commit statuses, the deployment will always succeed. * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. + * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text + * field that will be passed on when a deployment event is dispatched. * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. + * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might + * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an + * application with debugging enabled. * - * Merged branch response: + * Merged branch response: * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts + * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating + * a deployment. This auto-merge happens when: + * * Auto-merge option is enabled in the repository + * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example + * * There are no merge conflicts * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. + * If there are no new commits in the base branch, a new request to create a deployment should give a successful + * response. * - * Merge conflict response: + * Merge conflict response: * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. + * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't + * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. * - * Failed commit status checks: + * Failed commit status checks: * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` + * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deployment */ get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * 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. * - * To set a deployment as inactive, you must: + * To set a deployment as inactive, you must: * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. + * * 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/statuses#create-a-deployment-status)." + * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. + * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * This input example shows how you can use the `client_payload` as a test to debug your workflow. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment * @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)." * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-environment"]; /** * Create or update an environment * @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)." * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a deployment branch policy * @description Gets a deployment branch or tag policy for an environment. * - * Anyone with read access to the repository can use this endpoint. + * Anyone with read access to the repository can use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all deployment protection rules for an environment * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-deployment-protection-rules"]; + put?: never; /** * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-protection-rule"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List custom deployment rule integrations available for an environment * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-custom-deployment-rule-integrations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a custom deployment protection rule * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-custom-deployment-protection-rule"]; + put?: never; + post?: never; /** * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/disable-deployment-protection-rule"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment secrets * @description Lists all secrets available in an environment without revealing their - * encrypted values. + * encrypted values. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment public key * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. + * 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. + * Anyone with read access to the repository can use this endpoint. * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment secret * @description Gets a single environment secret without revealing its encrypted value. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-secret"]; /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-environment-secret"]; + post?: never; /** * Delete an environment secret * @description Deletes a secret in an environment using the secret name. * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List environment variables * @description Lists all environment variables. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-environment-variables"]; + put?: never; /** * Create an environment variable * @description Create an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an environment variable * @description Gets a specific variable in an environment. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; /** * Delete an environment variable * @description Deletes an environment variable using the variable name. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; /** * Update an environment variable * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read variables. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-environment-variable"]; + trace?: never; }; "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository events * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. + * */ get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List forks */ get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * - **`application/vnd.github.raw+json`**: Returns the raw blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. * - * **Note** This endpoint supports blobs up to 100 megabytes in size. + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a commit object * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." + * + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List matching references * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. + * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. + * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a reference * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a reference * @description Deletes the provided reference. */ delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** * Update a reference * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ patch: operations["git/update-ref"]; + trace?: never; }; "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * **Signature verification object** + * + * 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 | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tag * @description **Signature verification object** * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object: + * + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | + * + * These are the possible values for `reason` in the `verification` object: + * + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)." + * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)." * - * Returns an error if you try to delete a file that does not exist. + * Returns an error if you try to delete a file that does not exist. */ post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a tree * @description Returns a single tree using the SHA1 value or ref name for that tree. * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. + * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. * * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. + * share the same `config` as long as those webhooks do not have any `events` that overlap. */ post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** Delete a repository webhook */ delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ patch: operations["repos/update-webhook"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/import": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an import status * @deprecated * @description View the progress of an import. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Import status** + * **Import status** * - * This section includes details about the possible values of the `status` field of the Import Progress response. + * This section includes details about the possible values of the `status` field of the Import Progress response. * - * An import that does not have errors will progress through these steps: + * An import that does not have errors will progress through these steps: * - * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. - * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). - * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. - * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". - * * `complete` - the import is complete, and the repository is ready on GitHub. + * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. + * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). + * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. + * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". + * * `complete` - the import is complete, and the repository is ready on GitHub. * - * If there are problems, you will see one of these in the `status` field: + * If there are problems, you will see one of these in the `status` field: * - * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. - * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL. - * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. + * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. + * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. + * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. + * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL. + * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. * - * **The project_choices field** + * **The project_choices field** * - * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. + * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. * - * **Git LFS related fields** + * **Git LFS related fields** * - * This section includes details about Git LFS related fields that may be present in the Import Progress response. + * This section includes details about Git LFS related fields that may be present in the Import Progress response. * - * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. - * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. - * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. - * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. + * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. + * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. + * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. + * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ get: operations["migrations/get-import-status"]; /** * Start an import * @deprecated * @description Start a source import to a GitHub repository using GitHub Importer. - * Importing into a GitHub repository with GitHub Actions enabled is not supported and will - * return a status `422 Unprocessable Entity` response. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; + post?: never; /** * Cancel an import * @deprecated * @description Stop an import for a repository. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ delete: operations["migrations/cancel-import"]; + options?: never; + head?: never; /** * Update an import * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API - * request. If no parameters are provided, the import will be restarted. + * request. If no parameters are provided, the import will be restarted. * - * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will - * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. - * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. + * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will + * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. + * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; + trace?: never; }; "/repos/{owner}/{repo}/import/authors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get commit authors * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * - * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. + * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/import/authors/{author_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Map a commit author * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push - * new commits to the repository. + * new commits to the repository. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; + trace?: never; }; "/repos/{owner}/{repo}/import/large_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get large files * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + * */ get: operations["migrations/get-large-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/import/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update Git LFS preference * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability - * is powered by [Git LFS](https://git-lfs.com). + * is powered by [Git LFS](https://git-lfs.com). + * + * You can learn more about our LFS feature and working with large files [on our help + * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * You can learn more about our LFS feature and working with large files [on our help - * site](https://docs.github.com/repositories/working-with-files/managing-large-files). + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; + trace?: never; }; "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository installation for the authenticated app * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get interaction restrictions for a repository * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. @@ -6107,178 +10936,315 @@ export interface paths { * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ put: operations["interactions/set-restrictions-for-repo"]; + post?: never; /** * Remove interaction restrictions for a repository * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ delete: operations["interactions/remove-restrictions-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ patch: operations["repos/update-invitation"]; + trace?: never; }; "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository issues * @description List issues in a repository. Only open issues will be listed. * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments for a repository * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * - * By default, issue comments are ordered by ascending ID. + * By default, issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. * - * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). + * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events for a repository * @description Lists events for a repository. */ get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue event * @description Gets a single event by the event id. */ get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an issue * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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. + * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If + * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API + * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read + * 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 - * 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/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access can edit an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["issues/update"]; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. @@ -6289,59 +11255,107 @@ export interface paths { * @description Removes one or more assignees from an issue. */ delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user can be assigned to a issue * @description 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. + * 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. + * Otherwise a `404` status code is returned. */ get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue comments * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * Issue comments are ordered by ascending ID. + * Issue comments are ordered by ascending ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * - * 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. - * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. + * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List issue events * @description Lists all events for an issue. */ get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for an issue * @description Lists all labels for an issue. @@ -6362,167 +11376,375 @@ export interface paths { * @description Removes all labels from an issue. */ delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. * - * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). + * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List deploy keys */ get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get a deploy key */ get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for a repository * @description Lists all labels for a repository. */ get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a label * @description Gets a label using the given name. */ get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ patch: operations["issues/update-label"]; + trace?: never; }; "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List milestones * @description Lists milestones for a repository. */ get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ patch: operations["issues/update-milestone"]; + trace?: never; }; "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. @@ -6533,118 +11755,230 @@ export interface paths { * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GitHub Pages site * @description Gets information about a GitHub Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub Pages site * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Pages site * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub Pages site * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GitHub Pages builds * @description Lists builts of a GitHub Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. + * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Pages site. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Pages build * @description Gets information about a GitHub Pages build. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * The authenticated user must have write permission to the repository. + * The authenticated user must have write permission to the repository. */ post: operations["repos/create-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the status of a GitHub Pages deployment * @description Gets the current status of a GitHub Pages deployment. * - * The authenticated user must have read permission for the GitHub Pages site. + * The authenticated user must have read permission for the GitHub Pages site. */ get: operations["repos/get-pages-deployment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a GitHub Pages deployment * @description Cancels a GitHub Pages deployment. * - * The authenticated user must have write permissions for the GitHub Pages site. + * The authenticated user must have write permissions for the GitHub Pages site. */ post: operations["repos/cancel-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pages/health": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a DNS health check for GitHub Pages * @description Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. * - * 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. + * 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. * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-health-check"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if private vulnerability reporting is enabled for a repository * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". @@ -6655,280 +11989,452 @@ export interface paths { * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." */ put: operations["repos/enable-private-vulnerability-reporting"]; + post?: never; /** * Disable private vulnerability reporting for a repository * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". */ delete: operations["repos/disable-private-vulnerability-reporting"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository projects * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ get: operations["projects/list-for-repo"]; + put?: never; /** * Create a repository project * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all custom property values for a repository * @description Gets all custom property values that are set for a repository. - * Users with read access to the repository can use this endpoint. + * Users with read access to the repository can use this endpoint. */ get: operations["repos/get-custom-properties-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for a repository * @description Create new or update existing custom property values for a repository. - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ patch: operations["repos/create-or-update-custom-properties-values"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests * @description Lists pull requests in a specified repository. * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments in a repository * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. + * review comments are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review comment for a pull request * @description Provides details for a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` * - * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). + * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists details of a pull request by providing its number. + * Lists details of a pull request by providing its number. * - * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. + * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: + * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: * - * * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. + * * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. + * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. + * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * - * 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. + * 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. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * 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. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update"]; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-pr-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List review comments on a pull request * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. + * are in ascending order by ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reply for a review comment * @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. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" + * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List commits on a pull request * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) - * endpoint. + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) + * endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pull requests files * @description Lists the files in a specified pull request. * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. @@ -6937,16 +12443,29 @@ export interface paths { /** * Merge a pull request * @description Merges a pull request into the base branch. - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. @@ -6957,317 +12476,589 @@ export interface paths { * @description Removes review requests from a pull request for a given set of users and/or teams. */ delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reviews for a pull request * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." + * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/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. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List comments for a pull request review * @description Lists comments for a specific pull request review. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Update a pull request branch * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. */ put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README * @description Gets the preferred README for a repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository README for a directory * @description Gets the README from a repository directory. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List releases * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags). * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. + * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release asset * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. */ get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ patch: operations["repos/update-release-asset"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/generate-notes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Generate release notes content for a release * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ post: operations["repos/generate-release-notes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the latest release * @description View the latest published full release for the repository. * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. + * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a release * @description Gets a public release with the specified release ID. * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ patch: operations["repos/update-release"]; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List release assets */ get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. + * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. + * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: + * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: * - * `application/zip` + * `application/zip` * - * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. + * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, + * you'll still need to pass your authentication to be able to upload an asset. * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. + * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. * - * **Notes:** - * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + * **Notes:** + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" + * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. * - * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). + * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rules/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get rules for a branch * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply - * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level - * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" - * enforcement statuses are not returned. + * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level + * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" + * enforcement statuses are not returned. */ get: operations["repos/get-branch-rules"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all repository rulesets * @description Get all the rulesets for a repository. */ get: operations["repos/get-repo-rulesets"]; + put?: never; /** * Create a repository ruleset * @description Create a ruleset for a repository. */ post: operations["repos/create-repo-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository rule suites * @description Lists suites of rule evaluations at the repository level. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ get: operations["repos/get-repo-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository rule suite * @description Gets information about a suite of rule evaluations from within a repository. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ get: operations["repos/get-repo-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository ruleset * @description Get a ruleset for a repository. @@ -7278,213 +13069,430 @@ export interface paths { * @description Update a ruleset for a repository. */ put: operations["repos/update-repo-ruleset"]; + post?: never; /** * Delete a repository ruleset * @description Delete a ruleset for a repository. */ delete: operations["repos/delete-repo-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ patch: operations["secret-scanning/update-alert"]; + trace?: never; }; "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository security advisories * @description Lists security advisories in a repository. * - * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/list-repository-advisories"]; + put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. * - * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/reports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Privately report a security vulnerability * @description Report a security vulnerability to the maintainers of the repository. - * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. + * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. */ post: operations["security-advisories/create-private-vulnerability-report"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository security advisory * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. * - * Anyone can access any published security advisory on a public repository. + * Anyone can access any published security advisory on a public repository. * - * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a - * collaborator on the security advisory. + * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a + * collaborator on the security advisory. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/get-repository-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. * - * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, - * or a collaborator on the repository security advisory. + * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, + * or a collaborator on the repository security advisory. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ patch: operations["security-advisories/update-repository-advisory"]; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Request a CVE for a repository security advisory * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." * - * You may request a CVE for public repositories, but cannot do so for private repositories. + * You may request a CVE for public repositories, but cannot do so for private repositories. * - * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory-cve-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ post: operations["security-advisories/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List stargazers * @description Lists the people that have starred the repository. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit activity * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. */ get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all contributor commit activity * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: + * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). + * * `a` - Number of additions + * * `d` - Number of deletions + * * `c` - Number of commits * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the weekly commit count * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. * - * The array order is oldest week (index 0) to most recent week. + * The array order is oldest week (index 0) to most recent week. * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. + * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the hourly commit count for each day * @description Each array contains the day number, hour number, and number of commits: * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits + * * `0-6`: Sunday - Saturday + * * `0-23`: Hour of day + * * Number of commits * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. + * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. + * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List watchers * @description Lists the people watching the specified repository. */ get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. @@ -7495,102 +13503,254 @@ export interface paths { * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. */ put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). */ delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List repository tags */ get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List tag protection states for a repository * @description This returns the tag protection states of a repository. * - * This information is only available to repository administrators. + * This information is only available to repository administrators. */ get: operations["repos/list-tag-protection"]; + put?: never; /** * Create a tag protection state for a repository * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ post: operations["repos/create-tag-protection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a tag protection state for a repository * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. + * This endpoint is only available to repository administrators. */ delete: operations["repos/delete-tag-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (tar) * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. + * `main`) 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. */ get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository teams * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. * - * For a public repository, a team is listed only if that team added the public repository explicitly. + * For a public repository, a team is listed only if that team added the public repository explicitly. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Get all repository topics */ get: operations["repos/get-all-topics"]; /** Replace all repository topics */ put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/clones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get repository clones * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ get: operations["repos/get-clones"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/popular/paths": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get top referral paths * @description Get the top 10 popular contents over the last 14 days. */ get: operations["repos/get-top-paths"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/popular/referrers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get top referral sources * @description Get the top 10 referrers over the last 14 days. */ get: operations["repos/get-top-referrers"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/traffic/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get page views * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ get: operations["repos/get-views"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if vulnerability alerts are enabled for a repository * @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)". @@ -7601,382 +13761,630 @@ export interface paths { * @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)". */ put: operations["repos/enable-vulnerability-alerts"]; + post?: never; /** * Disable vulnerability alerts * @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)". + * 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)". */ delete: operations["repos/disable-vulnerability-alerts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a repository archive (zip) * @description 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 - * the `Location` header to make a second `GET` request. + * `main`) 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. + * **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. */ get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public repositories * @description Lists all public repositories in the order that they were created. * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. + * Note: + * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. + * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ get: operations["repos/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search code * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: + * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: * - * `q=addClass+in:file+language:js+repo:jquery/jquery` + * `q=addClass+in:file+language:js+repo:jquery/jquery` * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. + * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. * - * Considerations for code search: + * Considerations for code search: * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: + * Due to the complexity of searching code, there are a few restrictions on how searches are performed: * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. + * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. + * * Only files smaller than 384 KB are searchable. + * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing + * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. * - * This endpoint requires you to authenticate and limits you to 10 requests per minute. + * This endpoint requires you to authenticate and limits you to 10 requests per minute. */ get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search commits * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * - * 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/search/search#text-match-metadata). + * 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/search/search#text-match-metadata). * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: + * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: * - * `q=repo:octocat/Spoon-Knife+css` + * `q=repo:octocat/Spoon-Knife+css` */ get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search issues and pull requests * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted + * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. + * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` + * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. + * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search labels * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: + * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: * - * `q=bug+defect+enhancement&repository_id=64778136` + * `q=bug+defect+enhancement&repository_id=64778136` * - * The labels that best match the query appear first in the search results. + * The labels that best match the query appear first in the search results. */ get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search repositories * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: + * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: * - * `q=tetris+language:assembly&sort=stars&order=desc` + * `q=tetris+language:assembly&sort=stars&order=desc` * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. + * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search topics * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: + * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: * - * `q=ruby+is:featured` + * `q=ruby+is:featured` * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. + * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Search users * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). + * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). * - * For example, if you're looking for a list of popular users, you might try this query: + * For example, if you're looking for a list of popular users, you might try this query: * - * `q=tom+repos:%3E42+followers:%3E1000` + * `q=tom+repos:%3E42+followers:%3E1000` * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. + * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." + * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." */ get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. * - * To delete a team, the authenticated user must be an organization owner or team maintainer. + * To delete a team, the authenticated user must be an organization owner or team maintainer. * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. + * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. + * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. */ patch: operations["teams/update-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussions (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. + * List all discussions on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-legacy"]; + put?: never; /** * Create a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. + * Creates a new discussion post on a team's page. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. + * Get a specific discussion on a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-legacy"]; + put?: never; + post?: never; /** * Delete a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. + * Delete a discussion from a team's page. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-legacy"]; + options?: never; + head?: never; /** * Update a discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List discussion comments (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. + * List all comments on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-legacy"]; + put?: never; /** * Create a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. + * Creates a new comment on a team discussion. * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. + * Get a specific comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-legacy"]; + put?: never; + post?: never; /** * Delete a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. + * Deletes a comment on a team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-legacy"]; + options?: never; + head?: never; /** * Update a discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. + * Edits the body text of a discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-legacy"]; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; + put?: never; /** * Create reaction for a team discussion comment (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/discussions/{discussion_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List reactions for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-legacy"]; + put?: never; /** * Create reaction for a team discussion (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-legacy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List pending team invitations (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. * - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. + * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. */ get: operations["teams/list-pending-invitations-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team members (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. */ get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team member (Legacy) * @deprecated * @description The "Get team member" endpoint (described below) is deprecated. * - * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. + * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. * - * To list members in a team, the team must be visible to the authenticated user. + * To list members in a team, the team must be visible to the authenticated user. */ get: operations["teams/get-member-legacy"]; /** @@ -7984,46 +14392,57 @@ export interface paths { * @deprecated * @description The "Add team member" endpoint (described below) is deprecated. * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. + * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. * - * 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. + * 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 add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. + * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. * - * **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:** 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 that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated * @description The "Remove team member" endpoint (described below) is deprecated. * - * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. + * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. * - * 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. + * 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 team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. + * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. * - * **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:** 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/)." */ delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. * - * Team members will include the members of child teams. + * Team members will include the members of child teams. * - * To get a user's membership with a team, the team must be visible to the authenticated user. + * To get a user's membership with a team, the team must be visible to the authenticated user. * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. + * **Note:** + * The response contains the `state` of the membership and the member's `role`. * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). + * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ get: operations["teams/get-membership-for-user-legacy"]; /** @@ -8031,47 +14450,71 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. * - * 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. + * 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. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. * - * **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:** 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/)." * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. * - * If 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. + * If 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. */ put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. * - * 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. + * 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. + * 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:** 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/)." */ delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team projects (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. * - * Lists the organization projects for a team. + * Lists the organization projects for a team. */ get: operations["teams/list-projects-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/projects/{project_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a project (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. + * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. */ get: operations["teams/check-permissions-for-project-legacy"]; /** @@ -8079,35 +14522,59 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. + * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. */ put: operations["teams/add-or-update-project-permissions-legacy"]; + post?: never; /** * Remove a project from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. + * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. */ delete: operations["teams/remove-project-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List team repositories (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check team permissions for a repository (Legacy) * @deprecated * @description **Note**: Repositories inherited through a parent team will also be checked. * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: + * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: */ get: operations["teams/check-permissions-for-repo-legacy"]; /** @@ -8115,48 +14582,97 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. * - * 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. + * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." + * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. + * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. */ delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List child teams (Legacy) * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ patch: operations["users/update-authenticated"]; + trace?: never; }; "/user/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users blocked by the authenticated user * @description List the users you've blocked on your personal account. */ get: operations["users/list-blocked-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a user is blocked by the authenticated user * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. @@ -8167,233 +14683,433 @@ export interface paths { * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. */ put: operations["users/block"]; + post?: never; /** * Unblock a user * @description Unblocks the given user and returns a 204. */ delete: operations["users/unblock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List codespaces for the authenticated user * @description Lists the authenticated user's codespaces. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-for-authenticated-user"]; + put?: never; /** * Create a codespace for the authenticated user * @description Creates a new codespace, owned by the authenticated user. * - * This endpoint requires either a `repository_id` OR a `pull_request` but not both. + * This endpoint requires either a `repository_id` OR a `pull_request` but not both. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List secrets for the authenticated user * @description Lists all development environment secrets available for a user's codespaces without revealing their - * encrypted values. + * encrypted values. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-secrets-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get public key for the authenticated user * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-public-key-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a secret for the authenticated user * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + post?: never; /** * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/delete-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List selected repositories for a user secret * @description List the repositories that have been granted the ability to use a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. * - * The authenticated user must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a codespace for the authenticated user * @description Gets information about a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ delete: operations["codespaces/delete-for-authenticated-user"]; + options?: never; + head?: never; /** * Update a codespace for the authenticated user * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. * - * If you specify a new machine type it will be applied the next time your codespace is started. + * If you specify a new machine type it will be applied the next time your codespace is started. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ patch: operations["codespaces/update-for-authenticated-user"]; + trace?: never; }; "/user/codespaces/{codespace_name}/exports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * 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. * - * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. + * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/export-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/exports/{export_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get details about a codespace export * @description Gets information about an export of a codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-export-details-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List machine types for a codespace * @description List the machine types a codespace can transition to use. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/codespace-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository from an unpublished codespace * @description 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. + * 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. + * This will fail for a codespace that is already published, meaning it has an associated repository. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/publish-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/start": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Start a codespace for the authenticated user * @description Starts a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Stop a codespace for the authenticated user * @description Stops a user's codespace. * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/stop-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/email/visibility": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set primary email visibility for the authenticated user * @description Sets the visibility for your primary email addresses. */ patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; + trace?: never; }; "/user/emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List email addresses for the authenticated user * @description Lists all of your email addresses, and specifies which one is visible - * to the public. + * to the public. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-emails-for-authenticated-user"]; + put?: never; /** * Add an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. @@ -8404,104 +15120,213 @@ export interface paths { * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-email-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a person is followed by the authenticated user */ get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for the authenticated user * @description Lists the current user's GPG keys. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a GPG key for the authenticated user * @description View extended details for a single GPG key. * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You can find the permissions for the installation under the `permissions` key. + * You can find the permissions for the installation under the `permissions` key. */ get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories accessible to the user access token * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * The access the user has to each repository is included in the hash under the `permissions` key. + * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get interaction restrictions for your public repositories * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires. @@ -8512,367 +15337,729 @@ export interface paths { * @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. */ put: operations["interactions/set-restrictions-for-authenticated-user"]; + post?: never; /** * Remove interaction restrictions from your public repositories * @description Removes any interaction restrictions from your public repositories. */ delete: operations["interactions/remove-restrictions-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user account issues assigned to the authenticated user * @description 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 - * 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/pulls/pulls#list-pull-requests)" endpoint. + * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this + * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by + * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull + * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public SSH keys for the authenticated user * @description Lists the public SSH keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a public SSH key for the authenticated user * @description View extended details for a single public SSH key. * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/marketplace_purchases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List subscriptions for the authenticated user * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/marketplace_purchases/stubbed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List subscriptions for the authenticated user (stubbed) * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user migrations * @description Lists all migrations a user has started. */ get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user migration status * @description Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: * - * * `pending` - the migration hasn't started yet. - * * `exporting` - the migration is in progress. - * * `exported` - the migration finished successfully. - * * `failed` - the migration failed. + * * `pending` - the migration hasn't started yet. + * * `exporting` - the migration is in progress. + * * `exported` - the migration finished successfully. + * * `failed` - the migration failed. * - * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). + * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). */ get: operations["migrations/get-status-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Download a user migration archive * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. + * * attachments + * * bases + * * commit\_comments + * * issue\_comments + * * issue\_events + * * issues + * * milestones + * * organizations + * * projects + * * protected\_branches + * * pull\_request\_reviews + * * pull\_requests + * * releases + * * repositories + * * review\_comments + * * schema + * * users + * + * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a user migration archive * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ delete: operations["migrations/delete-archive-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Unlock a user repository * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ delete: operations["migrations/unlock-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/list-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-package-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package for the authenticated user * @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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list 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)." */ delete: operations["packages/delete-package-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for the authenticated user * @description Restores a package owned by the authenticated user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ post: operations["packages/restore-package-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-package-version-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package version for the authenticated user * @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. * - * The authenticated user must have admin permissions in the organization to use this endpoint. + * The authenticated user must have admin permissions in the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package version for the authenticated user * @description Restores a package version owned by the authenticated user. * - * You can restore a deleted package version under the following conditions: - * - 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. + * You can restore a deleted package version under the following conditions: + * - 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. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a user project * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. */ post: operations["projects/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/public_emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public email addresses for the authenticated user * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. + * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-public-emails-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for the authenticated user * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. + * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; "/user/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for the authenticated user * @description Lists all of your social accounts. */ get: operations["users/list-social-accounts-for-authenticated-user"]; + put?: never; /** * Add social accounts for the authenticated user * @description Add one or more social accounts to the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user * @description Deletes one or more social accounts from the authenticated user's profile. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-social-account-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for the authenticated user * @description Lists the SSH signing keys for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; + put?: never; /** * Create a SSH signing key for the authenticated user * @description Creates an SSH signing key for the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ post: operations["users/create-ssh-signing-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/ssh_signing_keys/{ssh_signing_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get an SSH signing key for the authenticated user * @description Gets extended details for an SSH signing key. * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/get-ssh-signing-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete an SSH signing key for the authenticated user * @description Deletes an SSH signing key from the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. @@ -8883,384 +16070,866 @@ export interface paths { * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List teams for the authenticated user * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. + * user belongs. * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List users * @description Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. + * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". + * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events for the authenticated user * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. */ get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organization events for the authenticated user * @description This is the user's organization dashboard. You must be authenticated as the user to view this. */ get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events for a user */ get: operations["activity/list-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List followers of a user * @description Lists the people following the specified user. */ get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** Check if a user follows another user */ get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List gists for a user * @description Lists public gists for the specified user: */ get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get contextual information for a user * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a user installation for the authenticated app * @description Enables an authenticated GitHub App to find the user’s installation information. * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List organizations for a user * @description List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. + * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/list-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-package-for-user"]; + put?: never; + post?: never; /** * Delete a package for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ delete: operations["packages/delete-package-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore a package for a user * @description Restores an entire package for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ post: operations["packages/restore-package-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ get: operations["packages/get-package-version-for-user"]; + put?: never; + post?: never; /** * Delete package version for a user * @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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ delete: operations["packages/delete-package-version-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Restore package version for a user * @description Restores a specific package version for a user. * - * You can restore a deleted package under the following conditions: - * - 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. + * You can restore a deleted package under the following conditions: + * - 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. * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." */ post: operations["packages/restore-package-version-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/projects": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List user projects * @description Lists projects for a user. */ get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List events received by the authenticated user * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ get: operations["activity/list-received-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/received_events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** List public events received by a user */ get: operations["activity/list-received-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/settings/billing/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Actions billing for a user * @description Gets the summary of the free and paid GitHub Actions minutes used. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/settings/billing/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get GitHub Packages billing for a user * @description Gets the free and paid storage used for GitHub Packages in gigabytes. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/settings/billing/shared-storage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get shared storage billing for a user * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List social accounts for a user * @description Lists social media accounts for a user. This endpoint is accessible by anyone. */ get: operations["users/list-social-accounts-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List SSH signing keys for a user * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. */ get: operations["users/list-ssh-signing-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories starred by a user * @description Lists repositories a user has starred. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. + * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get all API versions * @description Get all supported GitHub API versions. */ get: operations["meta/get-all-versions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; "/repos/{owner}/{repo}/compare/{base}...{head}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** * Compare two commits * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. * - * 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. + * 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. * - * 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. + * 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** + * **Working with large comparisons** * - * 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)." + * 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)." * - * 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. + * 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** + * **Signature verification object** * - * 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: + * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | + * | Name | Type | Description | + * | ---- | ---- | ----------- | + * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | + * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | + * | `signature` | `string` | The signature that was extracted from the commit. | + * | `payload` | `string` | The value that was signed. | * - * These are the possible values for `reason` in the `verification` object: + * These are the possible values for `reason` in the `verification` object: * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | + * | Value | Description | + * | ----- | ----------- | + * | `expired_key` | The key that made the signature is expired. | + * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | + * | `gpgverify_error` | There was an error communicating with the signature verification service. | + * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | + * | `unsigned` | The object does not include a signature. | + * | `unknown_signature_type` | A non-PGP signature was found in the commit. | + * | `no_user` | No user was associated with the `committer` email address in the commit. | + * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | + * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | + * | `unknown_key` | The key that made the signature has not been registered with any user's account. | + * | `malformed_signature` | There was an error parsing the signature. | + * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | + * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } - export type webhooks = Record; - export interface components { schemas: { root: { @@ -9365,7 +17034,7 @@ export interface components { /** @description The package version that resolves the vulnerability. */ first_patched_version: string | null; /** @description The functions in the package that are affected by the vulnerability. */ - vulnerable_functions: readonly string[] | null; + readonly vulnerable_functions: string[] | null; }; /** * Simple User @@ -9454,21 +17123,21 @@ export interface components { /** @description A GitHub Security Advisory. */ "global-advisory": { /** @description The GitHub Security Advisory ID. */ - ghsa_id: string; + readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - cve_id: string | null; + readonly cve_id: string | null; /** @description The API URL for the advisory. */ - url: string; + readonly url: string; /** * Format: uri * @description The URL for the advisory. */ - html_url: string; + readonly html_url: string; /** * Format: uri * @description The API URL for the repository advisory. */ - repository_advisory_url: string | null; + readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ summary: string; /** @description A detailed description of what the advisory entails. */ @@ -9477,7 +17146,7 @@ export interface components { * @description The type of advisory. * @enum {string} */ - type: "reviewed" | "unreviewed" | "malware"; + readonly type: "reviewed" | "unreviewed" | "malware"; /** * @description The severity of the advisory. * @enum {string} @@ -9488,8 +17157,8 @@ export interface components { * @description The URL of the advisory's source code. */ source_code_location: string | null; - identifiers: - | readonly { + readonly identifiers: + | { /** * @description The type of identifier. * @enum {string} @@ -9504,47 +17173,47 @@ export interface components { * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. */ - published_at: string; + readonly published_at: string; /** * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - updated_at: string; + readonly updated_at: string; /** * Format: date-time * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. */ - github_reviewed_at: string | null; + readonly github_reviewed_at: string | null; /** * Format: date-time * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. - * This field is only populated when the advisory is imported from the National Vulnerability Database. + * This field is only populated when the advisory is imported from the National Vulnerability Database. */ - nvd_published_at: string | null; + readonly nvd_published_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. */ - withdrawn_at: string | null; + readonly withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; /** @description The CVSS score. */ - score: number | null; + readonly score: number | null; } | null; cwes: | { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ - name: string; + readonly name: string; }[] | null; /** @description The users who contributed to the advisory. */ - credits: - | readonly { + readonly credits: + | { user: components["schemas"]["simple-user"]; type: components["schemas"]["security-advisory-credit-types"]; }[] @@ -9686,9 +17355,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -9701,9 +17370,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -9995,11 +17664,11 @@ export interface components { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ "app-permissions": { /** @@ -10295,12 +17964,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -10534,7 +18201,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -10567,7 +18234,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -10579,7 +18246,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -10600,69 +18267,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -10671,14 +18338,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -10702,12 +18369,10 @@ export interface components { single_file?: string; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; }; /** Scoped Installation */ @@ -10722,12 +18387,10 @@ export interface components { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** * Format: uri @@ -11161,53 +18824,52 @@ export interface components { * @example https://api.github.com/codes_of_conduct/contributor_covenant */ url: string; - /** - * @example # Contributor Covenant Code of Conduct + /** @example # Contributor Covenant Code of Conduct * - * ## Our Pledge + * ## Our Pledge * - * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. + * In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. * - * ## Our Standards + * ## Our Standards * - * Examples of behavior that contributes to creating a positive environment include: + * Examples of behavior that contributes to creating a positive environment include: * - * * Using welcoming and inclusive language - * * Being respectful of differing viewpoints and experiences - * * Gracefully accepting constructive criticism - * * Focusing on what is best for the community - * * Showing empathy towards other community members + * * Using welcoming and inclusive language + * * Being respectful of differing viewpoints and experiences + * * Gracefully accepting constructive criticism + * * Focusing on what is best for the community + * * Showing empathy towards other community members * - * Examples of unacceptable behavior by participants include: + * Examples of unacceptable behavior by participants include: * - * * The use of sexualized language or imagery and unwelcome sexual attention or advances - * * Trolling, insulting/derogatory comments, and personal or political attacks - * * Public or private harassment - * * Publishing others' private information, such as a physical or electronic address, without explicit permission - * * Other conduct which could reasonably be considered inappropriate in a professional setting + * * The use of sexualized language or imagery and unwelcome sexual attention or advances + * * Trolling, insulting/derogatory comments, and personal or political attacks + * * Public or private harassment + * * Publishing others' private information, such as a physical or electronic address, without explicit permission + * * Other conduct which could reasonably be considered inappropriate in a professional setting * - * ## Our Responsibilities + * ## Our Responsibilities * - * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response - * to any instances of unacceptable behavior. + * Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response + * to any instances of unacceptable behavior. * - * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + * Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. * - * ## Scope + * ## Scope * - * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, - * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. + * This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, + * posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. * - * ## Enforcement + * ## Enforcement * - * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. + * Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. * - * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. + * Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. * - * ## Attribution + * ## Attribution * - * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). - */ + * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). + * */ body?: string; /** Format: uri */ html_url: string | null; @@ -11260,17 +18922,17 @@ export interface components { | null; }; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -11285,7 +18947,7 @@ export interface components { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -11295,7 +18957,7 @@ export interface components { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -11309,14 +18971,14 @@ export interface components { readonly vector_string: string | null; }; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -11326,7 +18988,7 @@ export interface components { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -11353,37 +19015,37 @@ export interface components { * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; /** * Simple Repository * @description A GitHub repository. @@ -11632,10 +19294,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -11673,7 +19335,7 @@ export interface components { * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "nullable-alert-updated-at": string | null; + "nullable-alert-updated-at": string | null; /** * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. * @enum {string} @@ -11710,10 +19372,8 @@ export interface components { resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -11865,9 +19525,9 @@ export interface components { /** * @description The set of permissions for the GitHub app * @example { - * "issues": "read", - * "deployments": "write" - * } + * "issues": "read", + * "deployments": "write" + * } */ permissions: { issues?: string; @@ -11880,9 +19540,9 @@ export interface components { /** * @description The list of events for the GitHub app * @example [ - * "label", - * "deployment" - * ] + * "label", + * "deployment" + * ] */ events: string[]; /** @@ -11981,14 +19641,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -11998,9 +19657,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -12137,11 +19795,9 @@ export interface components { current_user_actor_url?: string; /** @example https://github.com/octocat-org */ current_user_organization_url?: string; - /** - * @example [ - * "https://github.com/organizations/github/octocat.private.atom?token=abc123" - * ] - */ + /** @example [ + * "https://github.com/organizations/github/octocat.private.atom?token=abc123" + * ] */ current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ security_advisories_url?: string; @@ -12188,13 +19844,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12335,13 +19993,15 @@ export interface components { /** Format: uri */ html_url: string; files: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - }; + [key: string]: + | { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + } + | undefined; }; public: boolean; /** Format: date-time */ @@ -12367,15 +20027,17 @@ export interface components { git_push_url?: string; html_url?: string; files?: { - [key: string]: { - filename?: string; - type?: string; - language?: string; - raw_url?: string; - size?: number; - truncated?: boolean; - content?: string; - } | null; + [key: string]: + | ({ + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; + } | null) + | undefined; }; public?: boolean; created_at?: string; @@ -12450,25 +20112,24 @@ export interface components { "gitignore-template": { /** @example C */ name: string; - /** - * @example # Object files - * *.o + /** @example # Object files + * *.o * - * # Libraries - * *.lib - * *.a + * # Libraries + * *.lib + * *.a * - * # Shared objects (inc. Windows DLLs) - * *.dll - * *.so - * *.so.* - * *.dylib + * # Shared objects (inc. Windows DLLs) + * *.dll + * *.so + * *.so.* + * *.dylib * - * # Executables - * *.exe - * *.out - * *.app - */ + * # Executables + * *.exe + * *.out + * *.app + * */ source: string; }; /** @@ -12519,53 +20180,46 @@ export interface components { description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ implementation: string; - /** - * @example [ - * "commercial-use", - * "modifications", - * "distribution", - * "sublicense", - * "private-use" - * ] - */ + /** @example [ + * "commercial-use", + * "modifications", + * "distribution", + * "sublicense", + * "private-use" + * ] */ permissions: string[]; - /** - * @example [ - * "include-copyright" - * ] - */ + /** @example [ + * "include-copyright" + * ] */ conditions: string[]; - /** - * @example [ - * "no-liability" - * ] - */ + /** @example [ + * "no-liability" + * ] */ limitations: string[]; - /** - * @example + /** @example * - * The MIT License (MIT) + * The MIT License (MIT) * - * Copyright (c) [year] [fullname] + * Copyright (c) [year] [fullname] * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * The above copyright notice and this permission notice shall be included in all - * copies or substantial portions of the Software. + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. - */ + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + * */ body: string; /** @example true */ featured: boolean; @@ -12607,12 +20261,10 @@ export interface components { unit_name: string | null; /** @example published */ state: string; - /** - * @example [ - * "Up to 25 private repositories", - * "11 concurrent builds" - * ] - */ + /** @example [ + * "Up to 25 private repositories", + * "11 concurrent builds" + * ] */ bullets: string[]; }; /** @@ -12657,71 +20309,49 @@ export interface components { SHA256_ECDSA?: string; SHA256_ED25519?: string; }; - /** - * @example [ - * "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" - * ] - */ + /** @example [ + * "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" + * ] */ ssh_keys?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ hooks?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ github_enterprise_importer?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ web?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ api?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ git?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ packages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ pages?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ importer?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ actions?: string[]; - /** - * @example [ - * "192.0.2.1" - * ] - */ + /** @example [ + * "192.0.2.1" + * ] */ dependabot?: string[]; domains?: { website?: string[]; @@ -13179,47 +20809,47 @@ export interface components { /** * @description Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ advanced_security_enabled_for_new_repositories?: boolean; /** * @description Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to - * this organization. + * this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @description Whether dependabot security updates are automatically enabled for new repositories and repositories transferred - * to this organization. + * to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @description Whether dependency graph is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ dependency_graph_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning is automatically enabled for new repositories and repositories transferred to this - * organization. + * organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_enabled_for_new_repositories?: boolean; /** * @description Whether secret scanning push protection is automatically enabled for new repositories and repositories - * transferred to this organization. + * transferred to this organization. * - * This field is only visible to organization owners or members of a team with the security manager role. + * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; @@ -13307,11 +20937,9 @@ export interface components { github_owned_allowed?: boolean; /** @description Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. */ verified_allowed?: boolean; - /** - * @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/*`. + /** @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/*`. * - * **Note**: The `patterns_allowed` setting only applies to public repositories. - */ + * **Note**: The `patterns_allowed` setting only applies to public repositories. */ patterns_allowed?: string[]; }; /** @@ -13406,12 +21034,10 @@ export interface components { * @example 2016-07-11T22:14:10Z */ expires_at: string; - /** - * @example { - * "issues": "read", - * "deployments": "write" - * } - */ + /** @example { + * "issues": "read", + * "deployments": "write" + * } */ permissions?: Record; /** @description The repositories this token has access to */ repositories?: components["schemas"]["repository"][]; @@ -13539,7 +21165,7 @@ export interface components { * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string} @@ -13583,10 +21209,8 @@ export interface components { version?: components["schemas"]["code-scanning-analysis-tool-version"]; guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ + /** @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. */ "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ "code-scanning-analysis-analysis-key": string; @@ -13624,10 +21248,8 @@ export interface components { }; location?: components["schemas"]["code-scanning-alert-location"]; html_url?: string; - /** - * @description Classifications that have been applied to the file that triggered the alert. - * For example identifying it as documentation, or a generated file. - */ + /** @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. */ classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; "code-scanning-organization-alert-items": { @@ -14528,12 +22150,10 @@ export interface components { deliveries_url?: string; /** @example web */ name: string; - /** - * @example [ - * "push", - * "pull_request" - * ] - */ + /** @example [ + * "push", + * "pull_request" + * ] */ events: string[]; /** @example true */ active: boolean; @@ -14792,13 +22412,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the request for access was created. */ @@ -14828,13 +22448,13 @@ export interface components { /** @description Permissions requested, categorized by type of permission. */ permissions: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ @@ -14927,13 +22547,11 @@ export interface components { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | string[] | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ description?: string | null; - /** - * @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. - */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; /** * @description Who can edit the values of the property @@ -14950,7 +22568,7 @@ export interface components { /** @description The name of the property */ property_name: string; /** @description The value assigned to the property */ - value: string | string[] | null; + value: (string | string[]) | null; }; /** * Organization Repository Custom Property Values @@ -15169,7 +22787,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -15202,7 +22820,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -15214,7 +22832,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -15235,69 +22853,69 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -15306,14 +22924,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; open_issues: number; watchers: number; master_branch?: string; @@ -15520,14 +23138,12 @@ export interface components { open_issues_count: number; /** @example true */ is_template?: boolean; - /** - * @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] - */ + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ topics?: string[]; /** @example true */ has_issues: boolean; @@ -15589,8 +23205,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @example PR_TITLE * @enum {string} */ @@ -15598,9 +23214,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -15608,8 +23224,8 @@ export interface components { /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @example PR_TITLE * @enum {string} */ @@ -15617,9 +23233,9 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @example PR_BODY * @enum {string} */ @@ -15644,7 +23260,7 @@ export interface components { * @description Whether anonymous git access is allowed. * @default true */ - anonymous_access_enabled?: boolean; + anonymous_access_enabled: boolean; code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; security_and_analysis?: components["schemas"]["security-and-analysis"]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ @@ -15662,7 +23278,8 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + * */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -15743,6 +23360,7 @@ export interface components { /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * */ "org-ruleset-conditions": | (components["schemas"]["repository-ruleset-conditions"] & @@ -16087,7 +23705,7 @@ export interface components { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -16103,7 +23721,7 @@ export interface components { bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** * @description The bypass type of the user making the API request for this ruleset. This field is only returned when - * querying the repository-level endpoint. + * querying the repository-level endpoint. * @enum {string} */ current_user_can_bypass?: "always" | "pull_requests_only" | "never"; @@ -16257,19 +23875,19 @@ export interface components { /** @description A repository security advisory. */ "repository-advisory": { /** @description The GitHub Security Advisory ID. */ - ghsa_id: string; + readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ cve_id: string | null; /** * Format: uri * @description The API URL for the advisory. */ - url: string; + readonly url: string; /** * Format: uri * @description The URL for the advisory. */ - html_url: string; + readonly html_url: string; /** @description A short summary of the advisory. */ summary: string; /** @description A detailed description of what the advisory entails. */ @@ -16280,10 +23898,10 @@ export interface components { */ severity: "critical" | "high" | "medium" | "low" | null; /** @description The author of the advisory. */ - author: components["schemas"]["simple-user"] | null; + readonly author: components["schemas"]["simple-user"] | null; /** @description The publisher of the advisory. */ - publisher: components["schemas"]["simple-user"] | null; - identifiers: readonly { + readonly publisher: components["schemas"]["simple-user"] | null; + readonly identifiers: { /** * @description The type of identifier. * @enum {string} @@ -16301,28 +23919,28 @@ export interface components { * Format: date-time * @description The date and time of when the advisory was created, in ISO 8601 format. */ - created_at: string | null; + readonly created_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - updated_at: string | null; + readonly updated_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. */ - published_at: string | null; + readonly published_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was closed, in ISO 8601 format. */ - closed_at: string | null; + readonly closed_at: string | null; /** * Format: date-time * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. */ - withdrawn_at: string | null; - submission: { + readonly withdrawn_at: string | null; + readonly submission: { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; @@ -16333,14 +23951,14 @@ export interface components { /** @description The CVSS vector. */ vector_string: string | null; /** @description The CVSS score. */ - score: number | null; + readonly score: number | null; } | null; - cwes: - | readonly { + readonly cwes: + | { /** @description The Common Weakness Enumeration (CWE) identifier. */ cwe_id: string; /** @description The name of the CWE. */ - name: string; + readonly name: string; }[] | null; /** @description A list of only the CWE IDs. */ @@ -16352,15 +23970,15 @@ export interface components { type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; - credits_detailed: - | readonly components["schemas"]["repository-advisory-credit"][] + readonly credits_detailed: + | components["schemas"]["repository-advisory-credit"][] | null; /** @description A list of users that collaborate on the advisory. */ collaborating_users: components["schemas"]["simple-user"][] | null; /** @description A list of teams that collaborate on the advisory. */ collaborating_teams: components["schemas"]["team"][] | null; /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ - private_fork: components["schemas"]["simple-repository"] | null; + readonly private_fork: components["schemas"]["simple-repository"] | null; }; /** * Team Simple @@ -17101,7 +24719,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** * @description Whether issues are enabled. @@ -17139,7 +24757,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -17160,44 +24778,44 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - allow_forking?: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -17532,10 +25150,10 @@ export interface components { /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ - * "self-hosted", - * "foo", - * "bar" - * ] + * "self-hosted", + * "foo", + * "bar" + * ] */ labels: string[]; /** @@ -17629,9 +25247,9 @@ export interface components { "actions-workflow-access-to-repository": { /** * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the - * repository. + * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. * @enum {string} */ access_level: "none" | "user" | "organization"; @@ -18003,14 +25621,11 @@ export interface components { * @example deploy */ task: string; - payload: OneOf< - [ - { + payload: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** @example staging */ original_environment?: string; /** @@ -18303,7 +25918,7 @@ export interface components { * @default false * @example true */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; }; /** * Branch Restriction Policy @@ -18450,12 +26065,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -18643,11 +26258,9 @@ export interface components { url: string; /** @example true */ strict: boolean; - /** - * @example [ - * "continuous-integration/travis-ci" - * ] - */ + /** @example [ + * "continuous-integration/travis-ci" + * ] */ contexts: string[]; checks: { /** @example continuous-integration/travis-ci */ @@ -18678,7 +26291,7 @@ export interface components { * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false */ - require_last_push_approval?: boolean; + require_last_push_approval: boolean; dismissal_restrictions?: { /** Format: uri */ url: string; @@ -18729,12 +26342,12 @@ export interface components { /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ lock_branch?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; /** @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. */ allow_fork_syncing?: { /** @default false */ - enabled?: boolean; + enabled: boolean; }; }; /** @@ -19112,12 +26725,12 @@ export interface components { * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; + "code-scanning-analysis-url": string; "code-scanning-analysis": { ref: components["schemas"]["code-scanning-ref"]; commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; @@ -19152,12 +26765,12 @@ export interface components { * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation */ - next_analysis_url: string | null; + readonly next_analysis_url: string | null; /** * Format: uri * @description Next deletable analysis in chain, with last analysis deletion confirmation */ - confirm_delete_url: string | null; + readonly confirm_delete_url: string | null; }; /** * CodeQL Database @@ -19254,10 +26867,8 @@ export interface components { | "swift" )[]; }; - /** - * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. - * You should not rely on this always being an actions workflow run object. - */ + /** @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. + * You should not rely on this always being an actions workflow run object. */ "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ run_id?: number; @@ -19266,7 +26877,7 @@ export interface components { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -19278,7 +26889,7 @@ export interface components { * Format: uri * @description The REST API URL for checking the status of the upload. */ - url?: string; + readonly url?: string; }; "code-scanning-sarifs-status": { /** @@ -19290,9 +26901,9 @@ export interface components { * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - analyses_url?: string | null; + readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** * CODEOWNERS errors @@ -19329,8 +26940,8 @@ export interface components { * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: * - * * user - * ^ + * * user + * ^ */ message: string; /** @@ -20223,10 +27834,10 @@ export interface components { * @description The state of the Dependabot alert. * @enum {string} */ - state: "auto_dismissed" | "dismissed" | "fixed" | "open"; + readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ - dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + readonly dependency: { + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -20366,19 +27977,19 @@ export interface components { name?: string; /** * @description The version of the package. If the package does not have an exact version specified, - * a version range is given. + * a version range is given. * @example 1.0.0 */ versionInfo?: string; /** * @description The location where the package can be downloaded, - * or NOASSERTION if this has not been determined. + * or NOASSERTION if this has not been determined. * @example NOASSERTION */ downloadLocation?: string; /** * @description Whether the package's file content has been subjected to - * analysis during the creation of the SPDX document. + * analysis during the creation of the SPDX document. * @example false */ filesAnalyzed?: boolean; @@ -20389,7 +28000,7 @@ export interface components { licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information - * was not available when the SPDX document was created. + * was not available when the SPDX document was created. * @example NOASSERTION */ licenseDeclared?: string; @@ -20423,7 +28034,7 @@ export interface components { * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ metadata: { - [key: string]: (string | number | boolean) | null; + [key: string]: ((string | number | boolean) | null) | undefined; }; dependency: { /** @@ -20466,7 +28077,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ resolved?: { - [key: string]: components["schemas"]["dependency"]; + [key: string]: components["schemas"]["dependency"] | undefined; }; }; /** @@ -20524,7 +28135,7 @@ export interface components { metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ manifests?: { - [key: string]: components["schemas"]["manifest"]; + [key: string]: components["schemas"]["manifest"] | undefined; }; /** * Format: date-time @@ -20572,7 +28183,7 @@ export interface components { * @default * @example production */ - environment?: string; + environment: string; /** * Format: uri * @description Deprecated: the URL to associate with this status. @@ -20606,14 +28217,14 @@ export interface components { * @default * @example https://staging.example.com/ */ - environment_url?: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - log_url?: string; + log_url: string; performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** @@ -20737,8 +28348,8 @@ export interface components { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -20754,8 +28365,8 @@ export interface components { /** * @description The name pattern that branches must match in order to deploy to the environment. * - * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. - * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ name: string; @@ -20985,43 +28596,43 @@ export interface components { /** * @description Objects specifying a tree structure * @example [ - * { - * "path": "file.rb", - * "mode": "100644", - * "type": "blob", - * "size": 30, - * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" + * { + * "path": "file.rb", + * "mode": "100644", + * "type": "blob", + * "size": 30, + * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", + * "properties": { + * "path": { + * "type": "string" + * }, + * "mode": { + * "type": "string" + * }, + * "type": { + * "type": "string" + * }, + * "size": { + * "type": "integer" + * }, + * "sha": { + * "type": "string" + * }, + * "url": { + * "type": "string" + * } + * }, + * "required": [ + * "path", + * "mode", + * "type", + * "sha", + * "url", + * "size" + * ] * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" * ] - * } - * ] */ tree: { /** @example test/file.rb */ @@ -21068,9 +28679,9 @@ export interface components { /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ - * "push", - * "pull_request" - * ] + * "push", + * "pull_request" + * ] */ events: string[]; config: components["schemas"]["webhook-config"]; @@ -21239,14 +28850,13 @@ export interface components { /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ - * "bug", - * "registration" - * ] - */ - labels: OneOf< - [ - string, - { + * "bug", + * "registration" + * ] + */ + labels: ( + | string + | { /** Format: int64 */ id?: number; node_id?: string; @@ -21256,9 +28866,8 @@ export interface components { description?: string | null; color?: string | null; default?: boolean; - }, - ] - >[]; + } + )[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; milestone: components["schemas"]["nullable-milestone"]; @@ -22060,7 +29669,7 @@ export interface components { * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -22076,7 +29685,7 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} @@ -22202,7 +29811,7 @@ export interface components { * @description Language */ language: { - [key: string]: number; + [key: string]: number | undefined; }; /** * License Content @@ -22342,9 +29951,9 @@ export interface components { /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ - * "example.com", - * "www.example.com" - * ] + * "example.com", + * "www.example.com" + * ] */ domains: string[]; /** Format: date */ @@ -23206,13 +30815,13 @@ export interface components { * @default RIGHT * @enum {string} */ - side?: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - start_side?: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT"; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 @@ -23407,10 +31016,8 @@ export interface components { resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ secret_type?: string; - /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." - */ + /** @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)." */ secret_type_display_name?: string; /** @description The secret that was detected. */ secret?: string; @@ -23673,7 +31280,7 @@ export interface components { * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - start_private_fork?: boolean; + start_private_fork: boolean; }; "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ @@ -23710,7 +31317,7 @@ export interface components { * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - start_private_fork?: boolean; + start_private_fork: boolean; }; "repository-advisory-update": { /** @description A short summary of the advisory. */ @@ -23780,17 +31387,15 @@ export interface components { * @description Commit Activity */ "commit-activity": { - /** - * @example [ - * 0, - * 3, - * 26, - * 20, - * 39, - * 1, - * 0 - * ] - */ + /** @example [ + * 0, + * 3, + * 26, + * 20, + * 39, + * 1, + * 0 + * ] */ days: number[]; /** @example 89 */ total: number; @@ -23805,16 +31410,14 @@ export interface components { author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ total: number; - /** - * @example [ - * { - * "w": "1367712000", - * "a": 6898, - * "d": 77, - * "c": 10 - * } - * ] - */ + /** @example [ + * { + * "w": "1367712000", + * "a": 6898, + * "d": 77, + * "c": 10 + * } + * ] */ weeks: { w?: number; a?: number; @@ -23989,12 +31592,10 @@ export interface components { language?: string | null; /** Format: date-time */ last_modified_at?: string; - /** - * @example [ - * "73..77", - * "77..78" - * ] - */ + /** @example [ + * "73..77", + * "77..78" + * ] */ line_numbers?: string[]; text_matches?: components["schemas"]["search-result-text-matches"]; }; @@ -24758,36 +32359,32 @@ export interface components { key_id: string; /** @example xsBNBFayYZ... */ public_key: string; - /** - * @example [ - * { - * "email": "octocat@users.noreply.github.com", - * "verified": true - * } - * ] - */ + /** @example [ + * { + * "email": "octocat@users.noreply.github.com", + * "verified": true + * } + * ] */ emails: { email?: string; verified?: boolean; }[]; - /** - * @example [ - * { - * "id": 4, - * "primary_key_id": 3, - * "key_id": "4A595D4C72EE49C7", - * "public_key": "zsBNBFayYZ...", - * "emails": [], - * "can_sign": false, - * "can_encrypt_comms": true, - * "can_encrypt_storage": true, - * "can_certify": false, - * "created_at": "2016-03-24T11:31:04-06:00", - * "expires_at": null, - * "revoked": false - * } - * ] - */ + /** @example [ + * { + * "id": 4, + * "primary_key_id": 3, + * "key_id": "4A595D4C72EE49C7", + * "public_key": "zsBNBFayYZ...", + * "emails": [], + * "can_sign": false, + * "can_encrypt_comms": true, + * "can_encrypt_storage": true, + * "can_certify": false, + * "created_at": "2016-03-24T11:31:04-06:00", + * "expires_at": null, + * "revoked": false + * } + * ] */ subkeys: { id?: number; primary_key_id?: number; @@ -24930,8 +32527,9 @@ export interface components { /** * Enterprise * @description An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured - * on an enterprise account or an organization that's part of an enterprise account. For more information, - * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." + * on an enterprise account or an organization that's part of an enterprise account. For more information, + * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." + * */ "enterprise-webhooks": { /** @description A short description of the enterprise. */ @@ -24979,8 +32577,8 @@ export interface components { /** * Simple Installation * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured - * for and sent to a GitHub App. For more information, - * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." + * for and sent to a GitHub App. For more information, + * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ "simple-installation": { /** @@ -24997,7 +32595,7 @@ export interface components { /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an - * organization, or when the event occurs from activity in a repository owned by an organization. + * organization, or when the event occurs from activity in a repository owned by an organization. */ "organization-simple-webhooks": { /** @example github */ @@ -25037,7 +32635,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "repository-webhooks": { /** @@ -25239,7 +32837,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ custom_properties?: { @@ -25275,7 +32873,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -25287,7 +32885,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -25308,7 +32906,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -25418,34 +33016,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -25459,62 +33057,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -25523,14 +33121,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -26110,8 +33708,8 @@ export interface components { repository_url: string; /** * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. * @enum {string} */ state: "open" | "closed" | "locked" | "converting" | "transferring"; @@ -27552,6 +35150,7 @@ export interface components { /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. + * */ "merge-group": { /** @description The SHA of the merge group. */ @@ -27567,7 +35166,7 @@ export interface components { /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * when the event occurs from activity in a repository. */ "nullable-repository-webhooks": { /** @@ -27769,7 +35368,7 @@ export interface components { * @default false * @example true */ - is_template?: boolean; + is_template: boolean; topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ custom_properties?: { @@ -27805,7 +35404,7 @@ export interface components { * @default false * @example true */ - has_discussions?: boolean; + has_discussions: boolean; /** * @description Whether the repository is archived. * @default false @@ -27817,7 +35416,7 @@ export interface components { * @description The repository visibility: public, private, or internal. * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z @@ -27838,7 +35437,7 @@ export interface components { * @default true * @example true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; template_repository?: { id?: number; node_id?: string; @@ -27948,34 +35547,34 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -27989,62 +35588,62 @@ export interface components { * @default true * @example true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - allow_update_branch?: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -28053,14 +35652,14 @@ export interface components { * @default true * @example true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - web_commit_signoff_required?: boolean; + web_commit_signoff_required: boolean; subscribers_count?: number; network_count?: number; open_issues: number; @@ -28202,37 +35801,37 @@ export interface components { /** @description New requested permissions, categorized by type of permission. */ permissions_added: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { organization?: { - [key: string]: string; + [key: string]: string | undefined; }; repository?: { - [key: string]: string; + [key: string]: string | undefined; }; other?: { - [key: string]: string; + [key: string]: string | undefined; }; }; /** @@ -28491,41 +36090,41 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -28533,7 +36132,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; }; /** Pull Request */ webhooks_pull_request_5: { @@ -28738,24 +36337,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -28791,7 +36390,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -28875,17 +36474,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -28952,7 +36551,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -28960,17 +36559,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -29002,7 +36601,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -29078,24 +36677,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -29131,7 +36730,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -29215,17 +36814,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -29292,7 +36891,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -29300,17 +36899,17 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -29342,7 +36941,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -29532,9 +37131,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -29569,8 +37167,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -29620,9 +37218,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -32189,7 +39786,7 @@ export interface components { created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ dismissed_at: string | null; - dismissed_by: Record | null; + dismissed_by: Record; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ dismissed_reason: string | null; /** @@ -33290,7 +40887,7 @@ export interface components { display_title: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -33609,7 +41206,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -33967,7 +41564,7 @@ export interface components { created_at: string; event: string; head_branch: string; - head_commit?: Record | null; + head_commit?: Record; head_repository?: { archive_url?: string; assignees_url?: string; @@ -34297,7 +41894,7 @@ export interface components { id: number; node_id: string; original_environment: string; - payload: string | Record | null; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -35295,24 +42892,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -35352,7 +42949,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -35491,7 +43088,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -35574,7 +43171,7 @@ export interface components { labels_url?: string; language?: unknown; languages_url?: string; - license?: Record | null; + license?: Record; merges_url?: string; milestones_url?: string; mirror_url?: unknown; @@ -36434,7 +44031,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -36461,10 +44058,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -37023,7 +44620,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37050,10 +44647,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -37615,7 +45212,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at?: string | null; @@ -37642,10 +45239,10 @@ export interface components { }[]; labels_url?: string; locked: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -38187,8 +45784,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; + assignee?: Record; + assignees?: Record[]; author_association?: string; body?: string | null; closed_at: string | null; @@ -38198,13 +45795,13 @@ export interface components { events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels?: Record[]; labels_url?: string; locked?: boolean; - milestone?: Record | null; + milestone?: Record; node_id?: string; number?: number; - performed_via_github_app?: Record | null; + performed_via_github_app?: Record; reactions?: { "+1"?: number; "-1"?: number; @@ -41631,24 +49228,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -41688,7 +49285,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -41829,7 +49426,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -43319,24 +50916,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -43376,7 +50973,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -43520,7 +51117,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -44278,12 +51875,10 @@ export interface components { /** @enum {string} */ action: "added"; changes?: { - /** - * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` - * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role - * assigned to the collaborator, use the `role_name` field instead, which will provide the full - * role name, including custom roles. - */ + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; @@ -44762,11 +52357,11 @@ export interface components { }; platform?: string; metadata?: { - [key: string]: string; + [key: string]: string | undefined; }; repo?: string; dependencies?: { - [key: string]: string; + [key: string]: string | undefined; }[]; commit_oid?: string; }; @@ -44866,8 +52461,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -44892,19 +52487,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: Record | null; - bugs?: Record | null; + author?: Record; + bugs?: Record; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: Record | null; + dist?: Record; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: Record | null; + repository?: Record; scripts?: Record; id?: string; node_version?: string; @@ -44917,7 +52512,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: Record | null; + directories?: Record; os?: string[]; cpu?: string[]; readme?: string; @@ -44931,19 +52526,16 @@ export interface components { | { id?: number | string; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -45820,22 +53412,19 @@ export interface components { "webhook-projects-v2-item-edited": { /** @enum {string} */ action: "edited"; - changes?: OneOf< - [ - { + changes?: + | { field_value: { field_node_id?: string; field_type?: string; }; - }, - { + } + | { body: { from?: string | null; to?: string | null; }; - }, - ] - >; + }; installation?: components["schemas"]["simple-installation"]; organization: components["schemas"]["organization-simple-webhooks"]; projects_v2_item: components["schemas"]["projects-v2-item"]; @@ -46095,24 +53684,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46148,7 +53737,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46232,17 +53821,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46309,7 +53898,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46317,9 +53906,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46329,8 +53918,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46362,7 +53951,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46438,24 +54027,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -46491,7 +54080,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -46575,17 +54164,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -46652,7 +54241,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -46660,9 +54249,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -46672,8 +54261,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -46705,7 +54294,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -46895,9 +54484,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -46932,8 +54520,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -46983,9 +54571,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -47307,24 +54894,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47360,7 +54947,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47444,17 +55031,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47521,7 +55108,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47529,9 +55116,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47541,8 +55128,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47574,7 +55161,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -47650,24 +55237,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -47703,7 +55290,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -47787,17 +55374,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -47864,7 +55451,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -47872,9 +55459,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -47884,8 +55471,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -47917,7 +55504,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48107,9 +55694,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48144,8 +55730,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -48195,9 +55781,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -48520,24 +56105,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48573,7 +56158,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -48657,17 +56242,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -48734,7 +56319,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -48742,9 +56327,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -48754,8 +56339,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -48787,7 +56372,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -48863,24 +56448,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -48916,7 +56501,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49000,17 +56585,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49077,7 +56662,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49085,9 +56670,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -49097,8 +56682,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -49130,7 +56715,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -49320,9 +56905,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49357,8 +56941,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -49408,9 +56992,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -49769,24 +57352,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -49822,7 +57405,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -49906,17 +57489,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -49983,7 +57566,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -49991,9 +57574,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50003,8 +57586,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50036,7 +57619,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50112,24 +57695,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -50165,7 +57748,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -50249,17 +57832,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -50326,7 +57909,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -50334,9 +57917,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -50346,8 +57929,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -50379,7 +57962,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -50569,9 +58152,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50606,8 +58188,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -50657,9 +58239,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -51013,24 +58594,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51066,7 +58647,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51150,17 +58731,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51227,7 +58808,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51235,9 +58816,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51247,8 +58828,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51280,7 +58861,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51356,24 +58937,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -51409,7 +58990,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -51493,17 +59074,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -51570,7 +59151,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -51578,9 +59159,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -51590,8 +59171,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -51623,7 +59204,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -51813,9 +59394,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51850,8 +59430,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -51901,9 +59481,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -52226,24 +59805,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52279,7 +59858,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52363,17 +59942,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52440,7 +60019,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52448,9 +60027,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52460,8 +60039,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52493,7 +60072,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -52569,24 +60148,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -52622,7 +60201,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -52706,17 +60285,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -52783,7 +60362,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -52791,9 +60370,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -52803,8 +60382,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -52836,7 +60415,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53026,9 +60605,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53063,8 +60641,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -53114,9 +60692,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -53438,24 +61015,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53491,7 +61068,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53575,17 +61152,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53652,7 +61229,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -53660,9 +61237,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -53672,8 +61249,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -53705,7 +61282,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -53781,24 +61358,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -53834,7 +61411,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -53918,17 +61495,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -53995,7 +61572,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -54003,9 +61580,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -54015,8 +61592,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -54048,7 +61625,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -54238,9 +61815,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54275,8 +61851,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -54326,9 +61902,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -54848,24 +62423,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -54901,7 +62476,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -54985,17 +62560,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -55062,7 +62637,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55070,9 +62645,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -55082,8 +62657,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -55115,7 +62690,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -55184,24 +62759,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -55237,7 +62812,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -55286,7 +62861,7 @@ export interface components { * @description Whether discussions are enabled. * @default false */ - has_discussions?: boolean; + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -55321,17 +62896,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -55398,7 +62973,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -55406,9 +62981,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -55418,8 +62993,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -55451,7 +63026,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -55596,9 +63171,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55633,8 +63207,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -55684,9 +63258,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -56000,24 +63573,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56053,7 +63626,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56137,17 +63710,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56214,7 +63787,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56222,9 +63795,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -56234,8 +63807,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -56267,7 +63840,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56336,24 +63909,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -56389,7 +63962,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -56473,17 +64046,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -56550,7 +64123,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -56558,9 +64131,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -56570,8 +64143,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -56603,7 +64176,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -56748,9 +64321,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56785,8 +64357,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -56836,9 +64408,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -57153,24 +64724,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57206,7 +64777,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57290,17 +64861,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57367,7 +64938,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57375,9 +64946,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57387,8 +64958,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57420,7 +64991,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57489,24 +65060,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -57542,7 +65113,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -57626,17 +65197,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -57703,7 +65274,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -57711,9 +65282,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -57723,8 +65294,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -57756,7 +65327,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -57901,9 +65472,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57938,8 +65508,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -57989,9 +65559,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -58305,24 +65874,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58358,7 +65927,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58442,17 +66011,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58519,7 +66088,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58527,9 +66096,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58539,8 +66108,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58572,7 +66141,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -58641,24 +66210,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -58694,7 +66263,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -58778,17 +66347,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -58855,7 +66424,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -58863,9 +66432,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -58875,8 +66444,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -58908,7 +66477,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -59053,9 +66622,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -59090,8 +66658,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -59141,9 +66709,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -59544,24 +67111,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59597,7 +67164,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -59736,7 +67303,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -59831,24 +67398,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -59884,7 +67451,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60023,7 +67590,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60194,9 +67761,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -60231,8 +67797,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -60282,9 +67848,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -60391,9 +67956,8 @@ export interface components { sender: components["schemas"]["simple-user-webhooks"]; }; /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": OneOf< - [ - { + "webhook-pull-request-review-request-removed": + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -60604,24 +68168,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60657,7 +68221,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -60741,17 +68305,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -60818,7 +68382,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -60864,7 +68428,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -60940,24 +68504,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -60993,7 +68557,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61077,17 +68641,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -61154,7 +68718,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -61162,9 +68726,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -61174,8 +68738,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -61207,7 +68771,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -61397,9 +68961,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -61434,8 +68997,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -61485,9 +69048,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -61634,8 +69196,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -61846,24 +69408,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -61899,7 +69461,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -61983,17 +69545,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -62060,7 +69622,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62068,9 +69630,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -62080,8 +69642,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -62113,7 +69675,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -62189,24 +69751,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -62242,7 +69804,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -62326,17 +69888,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -62403,7 +69965,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -62411,9 +69973,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -62423,8 +69985,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -62456,7 +70018,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -62646,9 +70208,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -62683,8 +70244,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -62734,9 +70295,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -62901,13 +70461,10 @@ export interface components { url: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request review_requested event */ - "webhook-pull-request-review-requested": OneOf< - [ - { + "webhook-pull-request-review-requested": + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -63118,24 +70675,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63171,7 +70728,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63255,17 +70812,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -63332,7 +70889,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63340,9 +70897,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -63352,8 +70909,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -63385,7 +70942,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -63461,24 +71018,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -63514,7 +71071,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -63598,17 +71155,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -63675,7 +71232,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -63683,9 +71240,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -63695,8 +71252,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -63728,7 +71285,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -63918,9 +71475,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -63955,8 +71511,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -64006,9 +71562,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -64155,8 +71710,8 @@ export interface components { url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; - }, - { + } + | { /** @enum {string} */ action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -64367,24 +71922,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64420,7 +71975,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64504,17 +72059,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -64581,7 +72136,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64589,9 +72144,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64601,8 +72156,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64634,7 +72189,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -64710,24 +72265,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -64763,7 +72318,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -64847,17 +72402,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -64924,7 +72479,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -64932,9 +72487,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -64944,8 +72499,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -64977,7 +72532,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65167,9 +72722,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -65204,8 +72758,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -65255,9 +72809,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -65422,9 +72975,7 @@ export interface components { url?: string; }; sender: components["schemas"]["simple-user-webhooks"]; - }, - ] - >; + }; /** pull_request_review submitted event */ "webhook-pull-request-review-submitted": { /** @enum {string} */ @@ -65634,24 +73185,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -65687,7 +73238,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -65771,17 +73322,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -65848,7 +73399,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -65856,9 +73407,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -65868,8 +73419,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -65901,7 +73452,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -65970,24 +73521,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66023,7 +73574,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66107,17 +73658,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -66184,7 +73735,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -66192,9 +73743,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -66204,8 +73755,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -66237,7 +73788,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -66382,9 +73933,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -66419,8 +73969,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -66470,9 +74020,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -66787,24 +74336,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -66840,7 +74389,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -66984,7 +74533,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67081,24 +74630,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -67134,7 +74683,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -67278,7 +74827,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -67451,9 +75000,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -67488,8 +75036,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -67539,9 +75087,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -68007,24 +75554,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68060,7 +75607,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68204,7 +75751,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68301,24 +75848,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -68354,7 +75901,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -68498,7 +76045,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -68671,9 +76218,8 @@ export interface components { number: number; /** Format: uri */ patch_url: string; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -68708,8 +76254,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -68759,9 +76305,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -69231,24 +76776,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69284,7 +76829,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -69368,17 +76913,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -69445,7 +76990,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69453,9 +76998,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -69465,8 +77010,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -69498,7 +77043,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -69574,24 +77119,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -69627,7 +77172,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -69781,7 +77326,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -69789,9 +77334,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -69801,8 +77346,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -69834,7 +77379,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -70024,9 +77569,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -70061,8 +77605,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -70112,9 +77656,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -70437,24 +77980,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70490,7 +78033,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70574,17 +78117,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -70651,7 +78194,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -70659,9 +78202,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -70671,8 +78214,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -70704,7 +78247,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -70780,24 +78323,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -70833,7 +78376,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -70917,17 +78460,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -70994,7 +78537,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71002,9 +78545,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -71014,8 +78557,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -71047,7 +78590,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -71237,9 +78780,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -71274,8 +78816,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -71325,9 +78867,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -71650,24 +79191,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -71703,7 +79244,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -71787,17 +79328,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -71864,7 +79405,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -71872,9 +79413,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -71884,8 +79425,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -71917,7 +79458,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -71993,24 +79534,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -72046,7 +79587,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72200,7 +79741,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -72208,9 +79749,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -72220,8 +79761,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -72253,7 +79794,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -72443,9 +79984,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -72480,8 +80020,8 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description: string | null; @@ -72531,9 +80071,8 @@ export interface components { * @description URL for the team */ url: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -72855,24 +80394,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -72908,7 +80447,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -72992,17 +80531,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -73069,7 +80608,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -73077,9 +80616,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -73089,8 +80628,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -73122,7 +80661,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -73198,24 +80737,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -73251,7 +80790,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -73335,17 +80874,17 @@ export interface components { /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; @@ -73412,7 +80951,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -73420,9 +80959,9 @@ export interface components { /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: @@ -73432,8 +80971,8 @@ export interface components { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -73465,7 +81004,7 @@ export interface components { * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -73655,9 +81194,8 @@ export interface components { /** Format: uri */ patch_url: string; rebaseable?: boolean | null; - requested_reviewers: OneOf< - [ - { + requested_reviewers: ( + | ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -73692,8 +81230,8 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null, - { + } | null) + | { deleted?: boolean; /** @description Description of the team */ description?: string | null; @@ -73743,9 +81281,8 @@ export interface components { * @description URL for the team */ url?: string; - }, - ] - >[]; + } + )[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ @@ -74000,24 +81537,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -74057,7 +81594,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -74201,7 +81738,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -74298,8 +81835,8 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels?: Record | null; - manifest?: Record | null; + labels?: Record; + manifest?: Record; tag?: { digest?: string; name?: string; @@ -74323,19 +81860,19 @@ export interface components { name?: string; version?: string; npm_user?: string; - author?: string | Record | null; - bugs?: string | Record | null; + author?: (string | Record) | null; + bugs?: (string | Record) | null; dependencies?: Record; dev_dependencies?: Record; peer_dependencies?: Record; optional_dependencies?: Record; description?: string; - dist?: string | Record | null; + dist?: (string | Record) | null; git_head?: string; homepage?: string; license?: string; main?: string; - repository?: string | Record | null; + repository?: (string | Record) | null; scripts?: Record; id?: string; node_version?: string; @@ -74348,7 +81885,7 @@ export interface components { files?: string[]; bin?: Record; man?: Record; - directories?: string | Record | null; + directories?: (string | Record) | null; os?: string[]; cpu?: string[]; readme?: string; @@ -74360,21 +81897,18 @@ export interface components { } | null; nuget_metadata?: | { - id?: string | Record | number | null; + id?: (string | Record | number) | null; name?: string; - value?: OneOf< - [ - boolean, - string, - number, - { + value?: + | boolean + | string + | number + | { url?: string; branch?: string; commit?: string; type?: string; - }, - ] - >; + }; }[] | null; package_files: { @@ -74571,7 +82105,7 @@ export interface components { updated_at: string; version: string; }; - registry: Record | null; + registry: Record; updated_at: string; }; repository?: components["schemas"]["repository-webhooks"]; @@ -75755,24 +83289,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -75812,7 +83346,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -75951,7 +83485,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -76004,24 +83538,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -76061,7 +83595,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -76200,7 +83734,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -76253,24 +83787,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -76310,7 +83844,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -76449,7 +83983,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -76533,24 +84067,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -76590,7 +84124,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -76729,7 +84263,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -76782,24 +84316,24 @@ export interface components { * @description Whether to allow auto-merge for pull requests. * @default false */ - allow_auto_merge?: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - allow_merge_commit?: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - allow_rebase_merge?: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - allow_squash_merge?: boolean; + allow_squash_merge: boolean; allow_update_branch?: boolean; /** Format: uri-template */ archive_url: string; @@ -76839,7 +84373,7 @@ export interface components { * @description Whether to delete head branches when pull requests are merged * @default false */ - delete_branch_on_merge?: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ deployments_url: string; description: string | null; @@ -76978,7 +84512,7 @@ export interface components { public?: boolean; /** Format: uri-template */ pulls_url: string; - pushed_at: number | string | null; + pushed_at: (number | string) | null; /** Format: uri-template */ releases_url: string; role_name?: string | null; @@ -77138,7 +84672,7 @@ export interface components { head_branch?: string | null; /** @description The name of the workflow. */ workflow_name?: string | null; - steps?: (Record | null)[]; + steps?: Record[]; url?: string; }; deployment?: components["schemas"]["deployment"]; @@ -78759,18 +86293,27 @@ export interface components { responses: { /** @description Validation failed, or the endpoint has been spammed. */ validation_failed_simple: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Resource not found */ not_found: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad Request */ bad_request: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; "application/scim+json": components["schemas"]["scim-error"]; @@ -78778,40 +86321,61 @@ export interface components { }; /** @description Validation failed, or the endpoint has been spammed. */ validation_failed: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ accepted: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description Not modified */ not_modified: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Requires authentication */ requires_authentication: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Internal Error */ internal_error: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Service unavailable */ service_unavailable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -78822,6 +86386,9 @@ export interface components { }; /** @description Forbidden Gist */ forbidden_gist: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { block?: { @@ -78836,18 +86403,27 @@ export interface components { }; /** @description Moved permanently */ moved_permanently: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Conflict */ conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response */ actions_runner_jitconfig: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { runner: components["schemas"]["runner"]; @@ -78858,6 +86434,9 @@ export interface components { }; /** @description Response */ actions_runner_labels: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -78867,6 +86446,9 @@ export interface components { }; /** @description Response */ actions_runner_labels_readonly: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -78876,60 +86458,93 @@ export interface components { }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ package_es_list_error: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description A header with no content is returned. */ no_content: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Gone */ gone: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Temporary Redirect */ temporary_redirect: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_read: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ code_scanning_forbidden_write: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Found */ found: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if there is already a validation run in progress with a different default setup configuration */ code_scanning_conflict: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ dependency_review_forbidden: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unavailable due to service under maintenance. */ porter_maintenance: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unacceptable */ unacceptable: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -78937,22 +86552,22 @@ export interface components { }; parameters: { /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-before"?: string; + "pagination-before": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "pagination-after"?: string; + "pagination-after": string; /** @description The direction to sort the results by. */ - direction?: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: string; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "per-page"?: number; + "per-page": number; /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ - cursor?: string; + cursor: string; "delivery-id": number; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - page?: number; + page: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: string; + since: string; /** @description The unique identifier of the installation. */ "installation-id": number; /** @description The client ID of the GitHub app. */ @@ -78964,86 +86579,72 @@ export interface components { "classroom-id": number; /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: string; - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - "dependabot-alert-comma-separated-states"?: string; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ + "dependabot-alert-comma-separated-states": string; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * - * Can be: `low`, `medium`, `high`, `critical` - */ - "dependabot-alert-comma-separated-severities"?: string; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * Can be: `low`, `medium`, `high`, `critical` */ + "dependabot-alert-comma-separated-severities": string; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - "dependabot-alert-comma-separated-ecosystems"?: string; + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ + "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - "dependabot-alert-comma-separated-packages"?: string; + "dependabot-alert-comma-separated-packages": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - "dependabot-alert-scope"?: "development" | "runtime"; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - */ - "dependabot-alert-sort"?: "created" | "updated"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first"?: number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last"?: number; + "dependabot-alert-scope": "development" | "runtime"; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ + "dependabot-alert-sort": "created" | "updated"; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ + "pagination-first": number; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ + "pagination-last": number; /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state"?: "open" | "resolved"; - /** - * @description A comma-separated list of secret types to return. By default all secret types are returned. - * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" - * for a complete list of secret types. - */ - "secret-scanning-alert-secret-type"?: string; + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution"?: string; + "secret-scanning-alert-resolution": string; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "secret-scanning-alert-sort"?: "created" | "updated"; + "secret-scanning-alert-sort": "created" | "updated"; /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ - "secret-scanning-alert-validity"?: string; + "secret-scanning-alert-validity": string; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: string; + labels: string; /** @description account_id parameter */ "account-id": number; /** @description The unique identifier of the plan. */ "plan-id": number; /** @description The property to sort the results by. */ - sort?: "created" | "updated"; + sort: "created" | "updated"; /** @description The account owner of the repository. The name is not case sensitive. */ owner: string; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: string; /** @description If `true`, show notifications marked as read. */ - all?: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - participating?: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - before?: string; + before: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - "since-org"?: number; + "since-org": number; /** @description The organization name. The name is not case sensitive. */ org: string; /** @description The unique identifier of the repository. */ @@ -79055,15 +86656,15 @@ export interface components { /** @description The name of the secret. */ "secret-name": string; /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - "variables-per-page"?: number; + "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; /** @description The handle for the GitHub user account. */ username: string; /** @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. */ - "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @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. */ - "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The unique identifier of the invitation. */ @@ -79078,13 +86679,11 @@ export interface components { "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For 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)." - */ - "package-visibility"?: "public" | "private" | "internal"; + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For 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)." */ + "package-visibility": "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ "package-type": | "npm" @@ -79098,44 +86697,40 @@ export interface components { /** @description Unique identifier of the package version. */ "package-version-id": number; /** @description The property by which to sort the results. */ - "personal-access-token-sort"?: "created_at"; + "personal-access-token-sort": "created_at"; /** @description A list of owner usernames to use to filter the results. */ - "personal-access-token-owner"?: string[]; + "personal-access-token-owner": string[]; /** @description The name of the repository to use to filter the results. */ - "personal-access-token-repository"?: string; + "personal-access-token-repository": string; /** @description The permission to use to filter the results. */ - "personal-access-token-permission"?: string; + "personal-access-token-permission": string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-before"?: string; + "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "personal-access-token-after"?: string; + "personal-access-token-after": string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; /** @description The custom property name. The name is case sensitive. */ "custom-property-name": string; /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ - "repository-name-in-query"?: number; - /** - * @description The time period to filter by. + "repository-name-in-query": number; + /** @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). - */ - "time-period"?: "hour" | "day" | "week" | "month"; + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ + "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - "actor-name-in-query"?: string; + "actor-name-in-query": string; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - "rule-suite-result"?: "pass" | "fail" | "bypass" | "all"; - /** - * @description The unique identifier of the rule suite result. - * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) - * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) - * for organizations. - */ + "rule-suite-result": "pass" | "fail" | "bypass" | "all"; + /** @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. */ "rule-suite-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - "secret-scanning-pagination-before-org-repo"?: string; + "secret-scanning-pagination-before-org-repo": string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - "secret-scanning-pagination-after-org-repo"?: string; + "secret-scanning-pagination-after-org-repo": string; /** @description The number that identifies the discussion. */ "discussion-number": number; /** @description The number that identifies the comment. */ @@ -79153,27 +86748,25 @@ export interface components { | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; - /** - * @description The action to take. + /** @description The action to take. * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; /** @description The unique identifier of the card. */ "card-id": number; /** @description The unique identifier of the column. */ "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - "artifact-name"?: string; + "artifact-name": string; /** @description The unique identifier of the artifact. */ "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - "actions-cache-git-ref-full"?: string; + "actions-cache-git-ref-full": string; /** @description An explicit key or prefix for identifying the cache */ - "actions-cache-key"?: string; + "actions-cache-key": string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - "actions-cache-list-sort"?: + "actions-cache-list-sort": | "created_at" | "last_accessed_at" | "size_in_bytes"; @@ -79184,13 +86777,13 @@ export interface components { /** @description The unique identifier of the job. */ "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - actor?: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - "workflow-run-branch"?: string; + "workflow-run-branch": string; /** @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)." */ - event?: string; + event: string; /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ - "workflow-run-status"?: + "workflow-run-status": | "completed" | "action_required" | "cancelled" @@ -79206,13 +86799,13 @@ export interface components { | "waiting" | "pending"; /** @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)." */ - created?: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - "exclude-pull-requests"?: boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - "workflow-run-check-suite-id"?: number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - "workflow-run-head-sha"?: string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ "run-id": number; /** @description The attempt number of the workflow run. */ @@ -79228,11 +86821,11 @@ export interface components { /** @description The unique identifier of the check suite. */ "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - "check-name"?: string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - status?: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @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`. */ - "git-ref"?: components["schemas"]["code-scanning-ref"]; + "git-ref": components["schemas"]["code-scanning-ref"]; /** @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. */ "alert-number": components["schemas"]["alert-number"]; /** @description The SHA of the commit. */ @@ -79240,16 +86833,14 @@ export interface components { /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ "commit-ref": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - "dependabot-alert-comma-separated-manifests"?: string; - /** - * @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. - */ + "dependabot-alert-comma-separated-manifests": string; + /** @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. */ "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - "manifest-path"?: string; + "manifest-path": string; /** @description deployment_id parameter */ "deployment-id": number; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ @@ -79264,7 +86855,7 @@ export interface components { */ "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ - "since-user"?: number; + "since-user": number; /** @description The number that identifies the issue. */ "issue-number": number; /** @description The unique identifier of the key. */ @@ -79282,31 +86873,31 @@ export interface components { /** @description The unique identifier of the release. */ "release-id": number; /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ - "ref-in-query"?: string; + "ref-in-query": string; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ - per?: "day" | "week"; + per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - "since-repo"?: number; + "since-repo": number; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ - order?: "desc" | "asc"; + order: "desc" | "asc"; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ - "repository-id-in-query"?: number; + "repository-id-in-query": number; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ "export-id": string; /** @description The unique identifier of the GPG key. */ "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "since-repo-date"?: string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - "before-repo-date"?: string; + "before-repo-date": string; /** @description The unique identifier of the SSH signing key. */ "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - "sort-starred"?: "created" | "updated"; + "sort-starred": "created" | "updated"; }; requestBodies: never; headers: { @@ -79327,32 +86918,28 @@ export interface components { }; pathItems: never; } - export type $defs = Record; - -export type external = Record; - export interface operations { - /** - * GitHub API Root - * @description Get Hypermedia links to resources accessible in GitHub's REST API - */ "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["root"]; }; }; }; }; - /** - * List global security advisories - * @description Lists all global security advisories that match the specified parameters. If no other parameters are defined, the request will return only GitHub-reviewed advisories that are not malware. - * - * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." - */ "security-advisories/list-global-advisories": { parameters: { query?: { @@ -79366,51 +86953,51 @@ export interface operations { ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ severity?: "unknown" | "low" | "medium" | "high" | "critical"; - /** - * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. + /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. * - * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` - */ + * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` */ cwes?: string | string[]; /** @description Whether to only return advisories that have been withdrawn. */ is_withdrawn?: boolean; - /** - * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. - * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. + /** @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. + * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` - */ + * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ affects?: string | string[]; - /** - * @description If specified, only return advisories that were published on a date or date range. + /** @description If specified, only return advisories that were published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ published?: string; - /** - * @description If specified, only return advisories that were updated on a date or date range. + /** @description If specified, only return advisories that were updated on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ updated?: string; - /** - * @description If specified, only show advisories that were updated or published on a date or date range. + /** @description If specified, only show advisories that were updated or published on a date or date range. * - * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." - */ + * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description The property to sort the results by. */ sort?: "updated" | "published"; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-advisory"][]; }; @@ -79418,25 +87005,32 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; /** @description Too many requests */ 429: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get a global security advisory - * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. - */ "security-advisories/get-global-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["global-advisory"]; }; @@ -79444,35 +87038,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the authenticated app - * @description Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; }; }; }; - /** - * Create a GitHub App from a manifest - * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. - */ "apps/create-from-manifest": { parameters: { + query?: never; + header?: never; path: { code: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"] & { client_id: string; @@ -79487,29 +87088,33 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a webhook configuration for an app - * @description Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an app - * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -79523,29 +87128,35 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an app webhook - * @description Returns a list of webhook deliveries for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -79554,21 +87165,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for an app webhook - * @description Returns a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -79577,38 +87189,41 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an app webhook - * @description Redeliver a delivery for the webhook configured for a GitHub App. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List installation requests for the authenticated app - * @description Lists all the pending installation requests for the authenticated GitHub App. - */ "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of integration installation requests */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration-installation-request"][]; }; @@ -79617,26 +87232,28 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List installations for the authenticated app - * @description You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * - * The permissions the installation has are included under the `permissions` key. - */ "apps/list-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; outdated?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description The permissions the installation has are included under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -79784,11 +87401,11 @@ export interface operations { * App Permissions * @description The permissions granted to the user access token. * @example { - * "contents": "read", - * "issues": "read", - * "deployments": "write", - * "single_file": "read" - * } + * "contents": "read", + * "issues": "read", + * "deployments": "write", + * "single_file": "read" + * } */ permissions: { /** @@ -79971,12 +87588,10 @@ export interface operations { single_file_name: string | null; /** @example true */ has_multiple_single_files?: boolean; - /** - * @example [ - * "config.yml", - * ".github/issue_TEMPLATE.md" - * ] - */ + /** @example [ + * "config.yml", + * ".github/issue_TEMPLATE.md" + * ] */ single_file_paths?: string[]; /** @example github-actions */ app_slug: string; @@ -80058,21 +87673,23 @@ export interface operations { }; }; }; - /** - * Get an installation for the authenticated app - * @description Enables an authenticated GitHub App to find an installation's information using the installation id. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -80080,43 +87697,37 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/delete-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. - * - * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. - * - * Optionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted. - * - * When using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/create-installation-access-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -80126,8 +87737,8 @@ export interface operations { /** * @description List of repository IDs that the token should have access to * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -80137,6 +87748,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation-token"]; }; @@ -80147,56 +87761,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/suspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unsuspend an app installation - * @description Removes a GitHub App installation suspension. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/unsuspend-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an app authorization - * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. - * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - */ "apps/delete-authorization": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80209,20 +87826,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Check a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. - */ "apps/check-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80235,6 +87855,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -80243,15 +87866,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an app token - * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. - */ "apps/delete-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80264,20 +87887,23 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Reset a token - * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - */ "apps/reset-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80290,6 +87916,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -80297,23 +87926,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a scoped access token - * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify - * which repositories the token can access and which permissions are granted to the - * token. - * - * Invalid tokens will return `404 NOT FOUND`. - * - * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) - * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App - * as the username and password. - */ "apps/scope-token": { parameters: { + query?: never; + header?: never; path: { + /** @description The client ID of the GitHub app. */ client_id: components["parameters"]["client-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80338,8 +87959,8 @@ export interface operations { /** * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example [ - * 1 - * ] + * 1 + * ] */ repository_ids?: number[]; permissions?: components["schemas"]["app-permissions"]; @@ -80349,6 +87970,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authorization"]; }; @@ -80359,19 +87983,22 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an app - * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - */ "apps/get-by-slug": { parameters: { + query?: never; + header?: never; path: { app_slug: components["parameters"]["app-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"]; }; @@ -80380,19 +88007,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get an assignment - * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. - */ "classroom/get-an-assignment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the classroom assignment. */ assignment_id: components["parameters"]["assignment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom-assignment"]; }; @@ -80400,42 +88031,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List accepted assignments for an assignment - * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. - */ "classroom/list-accepted-assigments-for-an-assignment": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The unique identifier of the classroom assignment. */ assignment_id: components["parameters"]["assignment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom-accepted-assignment"][]; }; }; }; }; - /** - * Get assignment grades - * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. - */ "classroom/get-assignment-grades": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the classroom assignment. */ assignment_id: components["parameters"]["assignment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom-assignment-grade"][]; }; @@ -80443,39 +88083,48 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List classrooms - * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. - */ "classroom/list-classrooms": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-classroom"][]; }; }; }; }; - /** - * Get a classroom - * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. - */ "classroom/get-a-classroom": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the classroom. */ classroom_id: components["parameters"]["classroom-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["classroom"]; }; @@ -80483,37 +88132,48 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List assignments for a classroom - * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. - */ "classroom/list-assignments-for-a-classroom": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The unique identifier of the classroom. */ classroom_id: components["parameters"]["classroom-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-classroom-assignment"][]; }; }; }; }; - /** - * Get all codes of conduct - * @description Returns array of all GitHub's codes of conduct. - */ "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"][]; }; @@ -80521,19 +88181,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a code of conduct - * @description Returns information about the specified GitHub code of conduct. - */ "codes-of-conduct/get-conduct-code": { parameters: { + query?: never; + header?: never; path: { key: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-of-conduct"]; }; @@ -80542,40 +88205,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get emojis - * @description Lists all the emojis available to use on GitHub. - */ "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { - [key: string]: string; + [key: string]: string | undefined; }; }; }; 304: components["responses"]["not_modified"]; }; }; - /** - * Get a summary of Copilot usage for enterprise members - * @description **Note**: This endpoint is in beta and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, - * and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage - * metrics for the enterprise. - * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. - */ "copilot/usage-metrics-for-enterprise": { parameters: { query?: { @@ -80583,17 +88235,25 @@ export interface operations { since?: string; /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-usage-metrics"][]; }; @@ -80604,39 +88264,60 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List Dependabot alerts for an enterprise - * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * - * The authenticated user must be a member of the enterprise to use this endpoint. - * - * 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. - */ "dependabot/list-alerts-for-enterprise": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -80647,38 +88328,44 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is 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). - * - * The authenticated user must be a member of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. - */ "secret-scanning/list-alerts-for-enterprise": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; }; + header?: never; path: { + /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ enterprise: components["parameters"]["enterprise"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -80688,20 +88375,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List public events - * @description We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago. - */ "activity/list-public-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -80711,49 +88403,47 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get feeds - * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. - * - * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - * * **Current user public**: The public timeline for the authenticated user - * * **Current user**: The private timeline for the authenticated user - * * **Current user actor**: The private timeline for activity created by the authenticated user - * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. - * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. - * - * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. - */ "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["feed"]; }; }; }; }; - /** - * List gists for the authenticated user - * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: - */ "gists/list": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -80763,13 +88453,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a gist - * @description Allows you to add a new gist with one or more files. - * - * **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. - */ "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -80781,16 +88471,18 @@ export interface operations { /** * @description Names and content for the files that make up the gist * @example { - * "hello.rb": { - * "content": "puts \"Hello, World!\"" - * } - * } + * "hello.rb": { + * "content": "puts \"Hello, World!\"" + * } + * } */ files: { - [key: string]: { - /** @description Content of the file */ - content: string; - }; + [key: string]: + | { + /** @description Content of the file */ + content: string; + } + | undefined; }; public?: boolean | ("true" | "false"); }; @@ -80802,6 +88494,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"]; @@ -80813,25 +88506,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List public gists - * @description List public gists sorted by most recently updated to least recently updated. - * - * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. - */ "gists/list-public": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -80842,23 +88537,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List starred gists - * @description List the authenticated user's starred gists: - */ "gists/list-starred": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -80869,24 +88568,23 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a gist - * @description Gets a specified gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -80896,32 +88594,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist */ "gists/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist - * @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. - */ "gists/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -80933,23 +88638,25 @@ export interface operations { description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename - * (including extension) of the targeted gist file. For example: `hello.py`. + * (including extension) of the targeted gist file. For example: `hello.py`. * - * To delete a file, set the whole file to null. For example: `hello.py : null`. + * To delete a file, set the whole file to null. For example: `hello.py : null`. * @example { - * "hello.rb": { - * "content": "blah", - * "filename": "goodbye.rb" - * } - * } + * "hello.rb": { + * "content": "blah", + * "filename": "goodbye.rb" + * } + * } */ files?: { - [key: string]: { - /** @description The new content of the file. */ - content?: string; - /** @description The new filename for the file. */ - filename?: string | null; - }; + [key: string]: + | { + /** @description The new content of the file. */ + content?: string; + /** @description The new filename for the file. */ + filename?: string | null; + } + | undefined; }; } | null; }; @@ -80957,6 +88664,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -80965,30 +88675,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List gist comments - * @description Lists the comments on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/list-comments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"][]; @@ -80999,20 +88707,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a gist comment - * @description Creates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81031,6 +88734,7 @@ export interface operations { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-comment"]; @@ -81041,25 +88745,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist comment - * @description Gets a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -81069,39 +88773,43 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a gist comment */ "gists/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update a gist comment - * @description Updates a comment on a gist. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -81117,6 +88825,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-comment"]; }; @@ -81124,23 +88835,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist commits */ "gists/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-commit"][]; @@ -81151,22 +88868,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** List gist forks */ "gists/list-forks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gist-simple"][]; @@ -81177,19 +88900,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Fork a gist */ "gists/fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"]; @@ -81201,84 +88929,104 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Check if a gist is starred */ "gists/check-is-starred": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if gist is starred */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; }; }; - /** - * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "gists/star": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** Unstar a gist */ "gists/unstar": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a gist revision - * @description Gets a specified gist revision. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. - */ "gists/get-revision": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the gist. */ gist_id: components["parameters"]["gist-id"]; sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gist-simple"]; }; @@ -81288,14 +89036,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all gitignore templates - * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). - */ "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -81303,23 +89057,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a gitignore template - * @description Get the content of a gitignore template. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. - */ "gitignore/get-template": { parameters: { + query?: never; + header?: never; path: { name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gitignore-template"]; }; @@ -81327,22 +89080,25 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * List repositories accessible to the app installation - * @description List repositories that an app installation can access. - */ "apps/list-repos-accessible-to-installation": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -81358,38 +89114,24 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Revoke an installation access token - * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. - * - * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - */ "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List issues assigned to the authenticated user - * @description List issues assigned to the authenticated user across all visible repositories including owned repositories, member - * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not - * necessarily assigned to you. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list": { parameters: { query?: { @@ -81403,24 +89145,34 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; collab?: boolean; orgs?: boolean; owned?: boolean; pulls?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -81431,21 +89183,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all commonly used licenses - * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get-all-commonly-used": { parameters: { query?: { featured?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-simple"][]; }; @@ -81453,19 +89210,22 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a license - * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." - */ "licenses/get": { parameters: { + query?: never; + header?: never; path: { license: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license"]; }; @@ -81475,8 +89235,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Render a Markdown document */ "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -81502,6 +89267,7 @@ export interface operations { /** @example 279 */ "Content-Length"?: string; "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -81510,11 +89276,13 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Render a Markdown document in raw mode - * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. - */ "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "text/plain": string; @@ -81526,6 +89294,7 @@ export interface operations { 200: { headers: { "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { "text/html": string; @@ -81534,21 +89303,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a subscription plan for an account - * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/get-subscription-plan-for-account": { parameters: { + query?: never; + header?: never; path: { + /** @description account_id parameter */ account_id: components["parameters"]["account-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["marketplace-purchase"]; }; @@ -81556,30 +89327,34 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List plans - * @description Lists all plans that are part of your GitHub Marketplace listing. - * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-plans": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-listing-plan"][]; @@ -81589,30 +89364,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List accounts for a plan - * @description Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-accounts-for-plan": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the plan. */ plan_id: components["parameters"]["plan-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-purchase"][]; @@ -81623,21 +89400,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a subscription plan for an account (stubbed) - * @description Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/get-subscription-plan-for-account-stubbed": { parameters: { + query?: never; + header?: never; path: { + /** @description account_id parameter */ account_id: components["parameters"]["account-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["marketplace-purchase"]; }; @@ -81645,28 +89424,32 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List plans (stubbed) - * @description Lists all plans that are part of your GitHub Marketplace listing. - * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-plans-stubbed": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-listing-plan"][]; @@ -81675,30 +89458,32 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List accounts for a plan (stubbed) - * @description Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change. - * - * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint. - */ "apps/list-accounts-for-plan-stubbed": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the plan. */ plan_id: components["parameters"]["plan-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["marketplace-purchase"][]; @@ -81707,20 +89492,20 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * Get GitHub meta information - * @description Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://docs.github.com/articles/about-github-s-ip-addresses/)." - * - * The API's response also includes a list of GitHub's domain names. - * - * The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. - * - * **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. - */ "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["api-overview"]; }; @@ -81728,21 +89513,30 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** List public events for a network of repositories */ "activity/list-public-events-for-repo-network": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; @@ -81753,27 +89547,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List notifications for the authenticated user - * @description List all notifications for the current user, sorted by most recently updated. - */ "activity/list-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -81785,11 +89585,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Mark notifications as read - * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -81806,6 +89608,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -81814,26 +89619,33 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread - * @description Gets information about a notification thread. - */ "activity/get-thread": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread"]; }; @@ -81843,57 +89655,67 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Mark a thread as done - * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. - */ "activity/mark-thread-as-done": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No content */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Mark a thread as read - * @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. - */ "activity/mark-thread-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get a thread subscription for the authenticated user - * @description This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/rest/activity/watching#get-a-repository-subscription). - * - * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. - */ "activity/get-thread-subscription-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -81903,19 +89725,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Set a thread subscription - * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. - * - * You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored. - * - * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. - */ "activity/set-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -81931,6 +89749,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["thread-subscription"]; }; @@ -81940,65 +89761,73 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a thread subscription - * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. - */ "activity/delete-thread-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ thread_id: components["parameters"]["thread-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Get Octocat - * @description Get the octocat as ASCII art - */ "meta/get-octocat": { parameters: { query?: { /** @description The words to show in Octocat's speech bubble */ s?: string; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/octocat-stream": string; }; }; }; }; - /** - * List organizations - * @description Lists all organizations, in the order that they were created. - * - * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. - */ "orgs/list": { parameters: { query?: { + /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -82007,38 +89836,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get an organization - * @description Gets information about an organization. - * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). - * - * To see the full details about an organization, the authenticated user must be an organization owner. - * - * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. - * - * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. - */ "orgs/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -82046,54 +89860,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization - * @description Deletes an organization and all its repositories. - * - * The organization login will be unavailable for 90 days after deletion. - * - * Please review the Terms of Service regarding account deletion before using this endpoint: - * - * https://docs.github.com/site-policy/github-terms/github-terms-of-service - */ "orgs/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization - * @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). - * - * Updates the organization's profile and member privileges. - * - * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: - * - * - advanced_security_enabled_for_new_repositories - * - dependabot_alerts_enabled_for_new_repositories - * - dependabot_security_updates_enabled_for_new_repositories - * - dependency_graph_enabled_for_new_repositories - * - secret_scanning_enabled_for_new_repositories - * - secret_scanning_push_protection_enabled_for_new_repositories - * - * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. - */ "orgs/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82135,7 +89927,7 @@ export interface operations { members_can_create_public_repositories?: boolean; /** * @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. - * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. + * **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details. * @enum {string} */ members_allowed_repository_creation_type?: "all" | "private" | "none"; @@ -82166,53 +89958,41 @@ export interface operations { web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ blog?: string; - /** - * @description Whether GitHub Advanced Security is automatically enabled for new repositories. + /** @description Whether GitHub Advanced Security is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ advanced_security_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot alerts is automatically enabled for new repositories. + /** @description Whether Dependabot alerts is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_alerts_enabled_for_new_repositories?: boolean; - /** - * @description Whether Dependabot security updates is automatically enabled for new repositories. + /** @description Whether Dependabot security updates is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependabot_security_updates_enabled_for_new_repositories?: boolean; - /** - * @description Whether dependency graph is automatically enabled for new repositories. + /** @description Whether dependency graph is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ dependency_graph_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning is automatically enabled for new repositories. + /** @description Whether secret scanning is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_enabled_for_new_repositories?: boolean; - /** - * @description Whether secret scanning push protection is automatically enabled for new repositories. + /** @description Whether secret scanning push protection is automatically enabled for new repositories. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ secret_scanning_push_protection_custom_link_enabled?: boolean; @@ -82224,6 +90004,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-full"]; }; @@ -82231,6 +90014,9 @@ export interface operations { 409: components["responses"]["conflict"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -82239,24 +90025,23 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions cache usage for an organization - * @description 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; @@ -82264,28 +90049,28 @@ export interface operations { }; }; }; - /** - * List repositories with GitHub Actions cache usage for an organization - * @description Lists repositories and their 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. - * - * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "actions/get-actions-cache-usage-by-repo-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -82296,38 +90081,38 @@ export interface operations { }; }; }; - /** - * Get the customization template for an OIDC subject claim for an organization - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "oidc/get-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A JSON serialized template for OIDC subject claim customization */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub"]; }; }; }; }; - /** - * Set the customization template for an OIDC subject claim for an organization - * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "oidc/update-oidc-custom-sub-template-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82337,6 +90122,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -82345,38 +90133,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get GitHub Actions permissions for an organization - * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-organization-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for an organization - * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82389,29 +90177,35 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -82421,18 +90215,15 @@ export interface operations { }; }; }; - /** - * Set selected repositories enabled for GitHub Actions in an organization - * @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)." - * - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-selected-repositories-enabled-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82445,82 +90236,91 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/enable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable a selected repository for GitHub Actions in an organization - * @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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/disable-selected-repository-github-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions and reusable workflows for an organization - * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions and reusable workflows for an organization - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-allowed-actions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82530,46 +90330,45 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for an organization - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, - * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see - * "[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)." - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for an organization - * @description 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 - * "[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)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -82579,35 +90378,37 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for an organization - * @description Lists all self-hosted runners configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-self-hosted-runners-for-org": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -82618,42 +90419,38 @@ export interface operations { }; }; }; - /** - * List runner applications for an organization - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-runner-applications-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for an organization - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the organization. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -82678,145 +90475,129 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for an organization - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for an organization - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for an organization - * @description Gets a specific self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/get-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from an organization - * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for an organization - * @description Lists all labels for a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for an organization - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-custom-labels-for-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82832,20 +90613,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for an organization - * @description Adds custom labels to a self-hosted runner configured in an organization. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -82861,77 +90639,67 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for an organization - * @description Remove all custom labels from a self-hosted runner configured in an - * organization. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for an organization - * @description Remove a custom label from a self-hosted runner configured - * in an organization. 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. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-custom-label-from-self-hosted-runner-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -82942,138 +90710,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to a repository to create, update, or read secrets - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to - * use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "actions/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -83095,61 +90790,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -83159,22 +90862,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -83187,91 +90885,97 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. For more information about setting the visibility, see [Create or - * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization variables - * @description Lists all organization variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-org-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -83282,19 +90986,15 @@ export interface operations { }; }; }; - /** - * Create an organization variable - * @description Creates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83316,72 +91016,74 @@ export interface operations { responses: { /** @description Response when creating a variable */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an organization variable - * @description Gets a specific variable in an organization. - * - * The authenticated user must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-actions-variable"]; }; }; }; }; - /** - * Delete an organization variable - * @description Deletes an organization variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an organization variable - * @description Updates an organization variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/update-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -83403,33 +91105,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization variable - * @description Lists all repositories that can access an organization variable - * that is available to selected repositories. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/list-selected-repos-for-org-variable": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -83439,26 +91145,24 @@ export interface operations { }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set selected repositories for an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/set-selected-repos-for-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -83471,172 +91175,205 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-selected-repo-to-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization variable - * @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`. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. - */ "actions/remove-selected-repo-from-org-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List users blocked by an organization - * @description List the users blocked by an organization. - */ "orgs/list-blocked-users": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - /** - * Check if a user is blocked by an organization - * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. - */ "orgs/check-blocked-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the user is blocked */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description If the user is not blocked */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Block a user from an organization - * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. - */ "orgs/block-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Unblock a user from an organization - * @description Unblocks the given user on behalf of the specified organization. - */ "orgs/unblock-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List code scanning alerts for an organization - * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alerts-for-org": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ state?: components["schemas"]["code-scanning-alert-state-query"]; @@ -83645,15 +91382,20 @@ export interface operations { /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; @@ -83663,25 +91405,28 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List codespaces for the organization - * @description Lists the codespaces associated to a specified organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/list-in-organization": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -83696,17 +91441,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Manage access control for organization codespaces - * @deprecated - * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/set-codespaces-access": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83728,33 +91471,33 @@ export interface operations { responses: { /** @description Response when successfully modifying permissions. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Add users to Codespaces access for an organization - * @deprecated - * @description Codespaces for the specified users will be billed to the organization. - * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/set-codespaces-access-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83767,33 +91510,33 @@ export interface operations { responses: { /** @description Response when successfully modifying permissions. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Remove users from Codespaces access for an organization - * @deprecated - * @description Codespaces for the specified users will no longer be billed to the organization. - * - * To use this endpoint, the access settings for the organization must be set to `selected_members`. - * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/delete-codespaces-access-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -83806,40 +91549,46 @@ export interface operations { responses: { /** @description Response when successfully modifying permissions. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List organization secrets - * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -83850,44 +91599,48 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets an organization development environment secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["codespaces-org-secret"]; @@ -83895,19 +91648,17 @@ export interface operations { }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -83929,60 +91680,72 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an organization secret - * @description Deletes an organization development environment secret using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -83993,20 +91756,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization development environment secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -84019,91 +91779,104 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization development environment secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get Copilot seat information and settings for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Gets information about an organization's Copilot subscription, including seat breakdown - * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - * - * Only organization owners can configure and view details about the organization's Copilot Business subscription. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/get-copilot-organization-details": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description OK */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-organization-details"]; }; @@ -84113,37 +91886,36 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description There is a problem with your account's associated payment method. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * List all Copilot seat assignments for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - * - * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/list-copilot-seats": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -84159,26 +91931,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Add teams to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Purchases a GitHub Copilot seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/add-copilot-seats-for-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84191,6 +91952,9 @@ export interface operations { responses: { /** @description OK */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_created: number; @@ -84202,31 +91966,23 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Remove teams from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for all members of each team specified. - * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/cancel-copilot-seat-assignment-for-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84239,6 +91995,9 @@ export interface operations { responses: { /** @description OK */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_cancelled: number; @@ -84250,31 +92009,23 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Add users to the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Purchases a GitHub Copilot seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/add-copilot-seats-for-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84287,6 +92038,9 @@ export interface operations { responses: { /** @description OK */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_created: number; @@ -84298,31 +92052,23 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Remove users from the Copilot subscription for an organization - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Cancels the Copilot seat assignment for each user specified. - * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - * - * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - * - * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - * - * Only organization owners can configure GitHub Copilot in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/cancel-copilot-seat-assignment-for-users": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84335,6 +92081,9 @@ export interface operations { responses: { /** @description OK */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { seats_cancelled: number; @@ -84346,28 +92095,14 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Get a summary of Copilot usage for organization members - * @description **Note**: This endpoint is in beta and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view - * Copilot usage metrics. - * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. - */ "copilot/usage-metrics-for-org": { parameters: { query?: { @@ -84375,17 +92110,25 @@ export interface operations { since?: string; /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-usage-metrics"][]; }; @@ -84396,37 +92139,60 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List Dependabot alerts for an organization - * @description Lists Dependabot alerts for an organization. - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-org": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; @@ -84438,28 +92204,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List organization secrets - * @description Lists all secrets available in an organization without revealing their - * encrypted values. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-org-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -84470,134 +92236,65 @@ export interface operations { }; }; }; - /** - * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to - * encrypt a secret before you can create or update secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/get-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - /** - * Create or update an organization secret - * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. - * - * #### Example encrypting a secret using Node.js - * - * Encrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library. - * - * ``` - * const sodium = require('tweetsodium'); - * - * 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 using LibSodium. - * const encryptedBytes = sodium.seal(messageBytes, keyBytes); - * - * // 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. - * - * ``` - * from base64 import b64encode - * from nacl import encoding, public - * - * def encrypt(public_key: str, secret_value: str) -> str: - * """Encrypt a Unicode string using the public key.""" - * public_key = public.PublicKey(public_key.encode("utf-8"), encoding.Base64Encoder()) - * sealed_box = public.SealedBox(public_key) - * encrypted = sealed_box.encrypt(secret_value.encode("utf-8")) - * return b64encode(encrypted).decode("utf-8") - * ``` - * - * #### Example encrypting a secret using C# - * - * Encrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package. - * - * ``` - * var secretValue = System.Text.Encoding.UTF8.GetBytes("mySecret"); - * var publicKey = Convert.FromBase64String("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU="); - * - * var sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey); - * - * Console.WriteLine(Convert.ToBase64String(sealedPublicKeyBox)); - * ``` - * - * #### Example encrypting a secret using Ruby - * - * Encrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem. - * - * ```ruby - * require "rbnacl" - * require "base64" - * - * key = Base64.decode64("+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=") - * public_key = RbNaCl::PublicKey.new(key) - * - * box = RbNaCl::Boxes::Sealed.from_public_key(public_key) - * encrypted_secret = box.encrypt("my_secret") - * - * # Print the base64 encoded secret - * puts Base64.strict_encode64(encrypted_secret) - * ``` - */ "dependabot/create-or-update-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -84619,57 +92316,69 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/delete-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` - * for repository access to a secret is set to `selected`. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/list-selected-repos-for-org-secret": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -84679,20 +92388,17 @@ export interface operations { }; }; }; - /** - * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/set-selected-repos-for-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -84705,79 +92411,92 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or - * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/add-selected-repo-to-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type is not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` - * for repository access is set to `selected`. The visibility is set when you [Create - * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "dependabot/remove-selected-repo-from-org-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when visibility type not set to selected */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get list of conflicting packages during Docker migration for organization - * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -84786,45 +92505,56 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** List public organization events */ "activity/list-public-org-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List failed organization invitations - * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. - */ "orgs/list-failed-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -84833,28 +92563,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization webhooks - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"][]; @@ -84863,20 +92593,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization webhook - * @description Create a hook that posts payloads in JSON format. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or - * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -84897,8 +92622,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -84915,6 +92640,7 @@ export interface operations { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-hook"]; @@ -84924,26 +92650,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook - * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -84951,47 +92676,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization webhook - * @description You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, - * the `secret` will be overwritten. If you previously had a `secret` set, you must - * provide the same `secret` or set a new `secret` or the secret will be removed. If - * you are only updating individual webhook `config` properties, use "[Update a webhook - * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85006,8 +92725,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -85023,6 +92742,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-hook"]; }; @@ -85031,46 +92753,42 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for an organization - * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for an organization - * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/update-webhook-config-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85085,36 +92803,40 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for an organization webhook - * @description Returns a list of webhook deliveries for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -85123,26 +92845,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook delivery for an organization webhook - * @description Returns a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -85151,99 +92873,95 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for an organization webhook - * @description Redeliver a delivery for a webhook configured in an organization. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - * to be sent to the hook. - * - * You must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit - * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. - */ "orgs/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an organization installation for the authenticated app - * @description Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-org-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes - * all GitHub Apps installed on repositories in the organization. - * - * The authenticated user must be an organization owner to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. - */ "orgs/list-app-installations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -85254,19 +92972,23 @@ export interface operations { }; }; }; - /** - * Get interaction restrictions for an organization - * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. - */ "interactions/get-restrictions-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["interaction-limit-response"] @@ -85275,15 +92997,15 @@ export interface operations { }; }; }; - /** - * Set interaction restrictions for an organization - * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. - */ "interactions/set-restrictions-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -85293,6 +93015,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["interaction-limit-response"]; }; @@ -85300,31 +93025,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove interaction restrictions for an organization - * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. - */ "interactions/remove-restrictions-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List pending organization invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - */ "orgs/list-pending-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Filter invitations by their member role. */ role?: @@ -85336,15 +93063,20 @@ export interface operations { /** @description Filter invitations by their invitation source. */ invitation_source?: "all" | "member" | "scim"; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -85353,18 +93085,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create an organization invitation - * @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. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - */ "orgs/create-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody?: { content: { @@ -85375,10 +93104,10 @@ export interface operations { email?: string; /** * @description The role for the new member. - * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. - * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. * @default direct_member * @enum {string} */ @@ -85391,6 +93120,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-invitation"]; }; @@ -85399,48 +93131,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Cancel an organization invitation - * @description 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). - */ "orgs/cancel-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List organization invitation teams - * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. - */ "orgs/list-invitation-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -85449,22 +93188,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization issues assigned to the authenticated user - * @description List issues in an organization assigned to the authenticated user. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-org": { parameters: { query?: { @@ -85478,23 +93201,33 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -85503,10 +93236,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization members - * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. - */ "orgs/list-members": { parameters: { query?: { @@ -85514,18 +93243,25 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -85534,75 +93270,93 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Check organization membership for a user - * @description Check if a user is, publicly or privately, a member of the organization. - */ "orgs/check-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if requester is an organization member and user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if requester is not an organization member */ 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization member - * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. - */ "orgs/remove-member": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * List codespaces for a user in organization - * @description Lists the codespaces that a member of an organization has for repositories in that organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/get-codespaces-for-user-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -85617,20 +93371,21 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete a codespace from the organization - * @description Deletes a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/delete-from-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 304: components["responses"]["not_modified"]; @@ -85640,23 +93395,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Stop a codespace for an organization user - * @description Stops a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "codespaces/stop-in-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -85668,26 +93427,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get Copilot seat assignment details for a user - * @description **Note**: This endpoint is in beta and is subject to change. - * - * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. - * - * Organization owners can view GitHub Copilot seat assignment details for members in their organization. - * - * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. - */ "copilot/get-copilot-seat-details-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The user's GitHub Copilot seat details, including usage. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-seat-details"]; }; @@ -85697,25 +93455,33 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 500: components["responses"]["internal_error"]; }; }; - /** - * Get organization membership for a user - * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. - */ "orgs/get-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -85724,32 +93490,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set organization membership for a user - * @description Only authenticated organization owners can add a member to the organization or update the member's role. - * - * * If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user) will be `pending` until they accept the invitation. - * - * * Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent. - * - * **Rate limits** - * - * To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. - */ "orgs/set-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. * @default member * @enum {string} */ @@ -85760,6 +93519,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -85768,51 +93530,55 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove organization membership for a user - * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. - * - * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. - */ "orgs/remove-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List organization migrations - * @description Lists the most recent migrations, including both exports (which can be started through the REST API) and imports (which cannot be started using the REST API). - * - * A list of `repositories` is only returned for export migrations. - */ "migrations/list-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -85820,15 +93586,15 @@ export interface operations { }; }; }; - /** - * Start an organization migration - * @description Initiates the generation of a migration archive. - */ "migrations/start-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -85883,6 +93649,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -85891,36 +93660,31 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization migration status - * @description Fetches the status of a migration. - * - * The `state` of a migration can be one of the following values: - * - * * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ "migrations/get-status-for-org": { parameters: { query?: { /** @description Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** - * @description * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -85928,84 +93692,104 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download an organization migration archive - * @description Fetches the URL to a migration archive. - */ "migrations/download-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Delete an organization migration archive - * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. - */ "migrations/delete-archive-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Unlock an organization repository - * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. - */ "migrations/unlock-repo-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * List repositories in an organization migration - * @description List all the repositories for this organization migration. - */ "migrations/list-repos-for-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -86014,28 +93798,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organization fine-grained permissions for an organization - * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-organization-fine-grained-permissions": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-fine-grained-permission"][]; }; @@ -86044,26 +93823,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-org-roles": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - list of organization roles */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description The total number of organization roles available to the organization. */ @@ -86077,22 +93853,15 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/create-custom-organization-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86109,6 +93878,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-role"]; }; @@ -86118,179 +93890,199 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-all-org-roles-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/assign-team-to-org-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization, team or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization role from a team - * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-org-role-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-all-org-roles-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/assign-user-to-org-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization, user or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove an organization role from a user - * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/revoke-org-role-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get an organization role - * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/get-org-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-role"]; }; @@ -86299,49 +94091,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a custom organization role. - * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/delete-custom-organization-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * - * To use this endpoint, the authenticated user must be one of: - * - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "orgs/patch-custom-organization-role": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -86358,6 +94141,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["organization-role"]; }; @@ -86367,30 +94153,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, you must be an administrator for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-org-role-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - List of assigned teams */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -86398,38 +94184,44 @@ export interface operations { }; /** @description Response if the organization or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - * - * To use this endpoint, you must be an administrator for the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/list-org-role-users": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response - List of assigned users */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -86437,35 +94229,44 @@ export interface operations { }; /** @description Response if the organization or role does not exist. */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List outside collaborators for an organization - * @description List all users who are outside collaborators of an organization. - */ "orgs/list-outside-collaborators": { parameters: { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -86473,16 +94274,17 @@ export interface operations { }; }; }; - /** - * Convert an organization member to outside collaborator - * @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)." - */ "orgs/convert-member-to-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -86498,39 +94300,56 @@ export interface operations { responses: { /** @description User is getting converted asynchronously */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; }; /** @description User was converted */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @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)." */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Remove outside collaborator from an organization - * @description Removing a user from this list will remove them from all the organization's repositories. - */ "orgs/remove-outside-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -86540,12 +94359,6 @@ export interface operations { }; }; }; - /** - * List packages for an organization - * @description Lists packages in an organization readable by the user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/list-packages-for-organization": { parameters: { query: { @@ -86557,19 +94370,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For 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)." */ visibility?: components["parameters"]["package-visibility"]; /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: number; /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -86579,112 +94403,120 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for an organization - * @description Gets a specific package in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-package-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/delete-package-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for an organization - * @description Restores an entire package in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/restore-package-for-org": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by an organization - * @description Lists package versions for a package owned by an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. 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)." - */ "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -86694,116 +94526,131 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for an organization - * @description Gets a specific package version in an organization. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-package-version-for-organization": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for an organization - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/delete-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for an organization - * @description Restores a specific package version in an organization. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/restore-package-version-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-requests": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; @@ -86815,17 +94662,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-requests-in-bulk": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86850,19 +94695,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/review-pat-grant-request": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; requestBody: { content: { @@ -86885,29 +94728,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-request-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ pat_request_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -86918,34 +94762,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grants": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-programmatic-access-grant"][]; @@ -86957,17 +94809,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-accesses": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -86990,18 +94840,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/update-pat-access": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the fine-grained personal access token. */ pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -87022,29 +94871,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. - * - * Only GitHub Apps can use this endpoint. - */ "orgs/list-pat-grant-repositories": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description Unique identifier of the fine-grained personal access token. */ pat_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -87055,27 +94905,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-org": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -87084,15 +94937,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -87107,6 +94960,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -87118,20 +94974,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get all custom properties for an organization - * @description Gets all custom properties defined for an organization. - * Organization members can read these properties. - */ "orgs/get-all-custom-properties": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"][]; }; @@ -87140,19 +94999,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update custom properties for an organization - * @description Creates new or updates existing custom properties defined for an organization in a batch. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - */ "orgs/create-or-update-custom-properties": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -87165,6 +95020,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"][]; }; @@ -87173,21 +95031,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a custom property for an organization - * @description Gets a custom property that is defined for an organization. - * Organization members can read these properties. - */ "orgs/get-custom-property": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The custom property name. The name is case sensitive. */ custom_property_name: components["parameters"]["custom-property-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"]; }; @@ -87196,20 +95058,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update a custom property for an organization - * @description Creates a new or updates an existing custom property that is defined for an organization. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - */ "orgs/create-or-update-custom-property": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The custom property name. The name is case sensitive. */ custom_property_name: components["parameters"]["custom-property-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -87223,13 +95082,11 @@ export interface operations { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | string[] | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ description?: string | null; - /** - * @description An ordered list of the allowed values of the property. - * The property can have up to 200 allowed values. - */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; }; }; @@ -87237,6 +95094,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-custom-property"]; }; @@ -87245,49 +95105,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom property for an organization - * @description Removes a custom property that is defined for an organization. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. - */ "orgs/remove-custom-property": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The custom property name. The name is case sensitive. */ custom_property_name: components["parameters"]["custom-property-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List custom property values for organization repositories - * @description Lists organization repositories with all of their custom property values. - * Organization members can read these properties. - */ "orgs/list-custom-properties-values-for-repos": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ repository_query?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-repo-custom-property-values"][]; @@ -87297,24 +95157,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update custom property values for organization repositories - * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. - * Each target repository will have its custom property values updated to match the values provided in the request. - * - * A maximum of 30 repositories can be updated in a single request. - * - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - * - * To use this endpoint, the authenticated user must be one of: - * - An administrator for the organization. - * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. - */ "orgs/create-or-update-custom-properties-values-for-repos": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -87329,32 +95180,38 @@ export interface operations { responses: { /** @description No Content when custom property values are successfully created or updated */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List public organization members - * @description Members of an organization can choose to have their membership publicized or not. - */ "orgs/list-public-members": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -87362,73 +95219,83 @@ export interface operations { }; }; }; - /** - * Check public organization membership for a user - * @description Check if the provided user is a public member of the organization. - */ "orgs/check-public-membership-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a public member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a public member */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set public organization membership for the authenticated user - * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "orgs/set-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Remove public organization membership for the authenticated user - * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. - */ "orgs/remove-public-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List organization repositories - * @description 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)." - */ "repos/list-for-org": { parameters: { query?: { @@ -87438,18 +95305,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -87457,17 +95331,15 @@ export interface operations { }; }; }; - /** - * Create an organization repository - * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -87559,34 +95431,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -87603,6 +95475,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -87612,23 +95485,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all organization repository rulesets - * @description Get all the repository rulesets for an organization. - */ "repos/get-org-rulesets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"][]; }; @@ -87637,15 +95515,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create an organization repository ruleset - * @description Create a repository ruleset for an organization. - */ "repos/create-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; /** @description Request body */ requestBody: { @@ -87656,7 +95534,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -87672,6 +95550,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -87680,28 +95561,38 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List organization rule suites - * @description Lists suites of rule evaluations at the organization level. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." - */ "repos/get-org-rule-suites": { parameters: { query?: { + /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ repository_name?: components["parameters"]["repository-name-in-query"]; + /** @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suites"]; }; @@ -87710,21 +95601,28 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get an organization rule suite - * @description Gets information about a suite of rule evaluations from within an organization. - * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." - */ "repos/get-org-rule-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. */ rule_suite_id: components["parameters"]["rule-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suite"]; }; @@ -87733,21 +95631,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get an organization repository ruleset - * @description Get a repository ruleset for an organization. - */ "repos/get-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -87756,17 +95658,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update an organization repository ruleset - * @description Update a ruleset for an organization. - */ "repos/update-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; /** @description Request body */ requestBody?: { @@ -87777,7 +95679,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -87793,6 +95695,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -87801,58 +95706,71 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete an organization repository ruleset - * @description Delete a ruleset for an organization. - */ "repos/delete-org-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List secret scanning alerts for an organization - * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-org": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-secret-scanning-alert"][]; @@ -87862,34 +95780,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository security advisories for an organization - * @description Lists repository security advisories for an organization. - * - * The authenticated user must be an owner or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/list-org-repository-advisories": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"][]; }; @@ -87898,165 +95818,151 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List security manager teams - * @description Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an administrator or security manager for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. - */ "orgs/list-security-manager-teams": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - /** - * Add a security manager team - * @description Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/add-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The organization has reached the maximum number of security manager teams. */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a security manager team - * @description Removes the security manager role from a team for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." - * - * The authenticated user must be an administrator for the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - */ "orgs/remove-security-manager-team": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. - * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - */ "billing/get-github-actions-billing-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-billing-usage"]; }; }; }; }; - /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - */ "billing/get-github-packages-billing-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["packages-billing-usage"]; }; }; }; }; - /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - */ "billing/get-shared-storage-billing-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-billing-usage"]; }; }; }; }; - /** - * Get a summary of Copilot usage for a team - * @description **Note**: This endpoint is in beta and is subject to change. - * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for the prior 28 days. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * **Note**: This endpoint will only return results for a given day if the team had five or more members on that day. - * - * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, - * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. - */ "copilot/usage-metrics-for-team": { parameters: { query?: { @@ -88064,18 +95970,27 @@ export interface operations { since?: string; /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */ until?: string; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["copilot-usage-metrics"][]; }; @@ -88086,25 +96001,28 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List teams - * @description Lists all teams in an organization that are visible to the authenticated user. - */ "teams/list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -88113,17 +96031,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a team - * @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)." - * - * 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)". - */ "teams/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -88138,21 +96054,21 @@ export interface operations { repo_names?: string[]; /** * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` * @enum {string} */ notification_setting?: @@ -88172,6 +96088,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -88180,22 +96099,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a team by name - * @description Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. - */ "teams/get-by-name": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -88203,40 +96125,40 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team - * @description To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. - */ "teams/delete-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a team - * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. - */ "teams/update-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88247,18 +96169,18 @@ export interface operations { description?: string; /** * @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: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -88278,12 +96200,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -88293,33 +96221,34 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Pinned discussions only filter */ pinned?: string; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -88327,22 +96256,17 @@ export interface operations { }; }; }; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; requestBody: { content: { @@ -88362,75 +96286,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88445,38 +96374,43 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-in-org": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -88484,23 +96418,19 @@ export interface operations { }; }; }; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * **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`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -88513,78 +96443,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -88597,20 +96535,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-in-org": { parameters: { query?: { @@ -88624,21 +96557,31 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -88646,24 +96589,21 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -88687,51 +96627,53 @@ export interface operations { responses: { /** @description Response when the reaction type has already been added to this team discussion comment */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion comment reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-in-org": { parameters: { query?: { @@ -88745,20 +96687,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -88766,23 +96717,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -88806,64 +96753,75 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * Delete team discussion reaction - * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/delete-for-team-discussion": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List pending team invitations - * @description The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. - */ "teams/list-pending-invitations-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -88871,30 +96829,32 @@ export interface operations { }; }; }; - /** - * List team members - * @description Team members will include the members of child teams. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/list-members-in-org": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -88902,61 +96862,53 @@ export interface operations { }; }; }; - /** - * Get team membership for a user - * @description Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). - */ "teams/get-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ 404: { - content: never; - }; - }; - }; - /** - * Add or update team membership for a user - * @description 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. - * - * **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. - * - * If 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. - * - * **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}`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-or-update-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -88973,71 +96925,85 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user - * @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. - * - * 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. - * - * **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}`. - */ "teams/remove-membership-for-user-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ "teams/list-projects-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -89045,46 +97011,53 @@ export interface operations { }; }; }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/check-permissions-for-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions - * @description Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/add-or-update-project-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89100,10 +97073,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -89113,49 +97092,55 @@ export interface operations { }; }; }; - /** - * Remove a project from a team - * @description Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ "teams/remove-project-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team repositories - * @description Lists a team's repositories visible to the authenticated user. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. - */ "teams/list-repos-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -89163,60 +97148,64 @@ export interface operations { }; }; }; - /** - * Check team permissions for a repository - * @description Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header. - * - * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - * - * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/check-permissions-for-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with repository permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team does not have permission for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions - * @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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * **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)". - */ "teams/add-or-update-repo-permissions-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89232,54 +97221,64 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove a repository from a team - * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. - */ "teams/remove-repo-in-org": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams - * @description Lists the child teams of the team specified by `{team_slug}`. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. - */ "teams/list-child-in-org": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -89287,28 +97286,29 @@ export interface operations { }; }; }; - /** - * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - * - * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. - */ "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ security_product: components["parameters"]["security-product"]; + /** @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. */ enablement: components["parameters"]["org-security-product-enablement"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. - * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. * @enum {string} */ query_suite?: "default" | "extended"; @@ -89318,27 +97318,37 @@ export interface operations { responses: { /** @description Action started */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a project card - * @description Gets information about a project card. - */ "projects/get-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -89349,25 +97359,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project card - * @description Deletes a project card - */ "projects/delete-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -89379,12 +97396,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Update an existing project card */ "projects/update-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89405,6 +97425,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -89416,12 +97439,15 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** Move a project card */ "projects/move-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the card. */ card_id: components["parameters"]["card-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89442,6 +97468,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -89450,6 +97479,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -89466,6 +97498,9 @@ export interface operations { 422: components["responses"]["validation_failed"]; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -89480,19 +97515,23 @@ export interface operations { }; }; }; - /** - * Get a project column - * @description Gets information about a project column. - */ "projects/get-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -89503,32 +97542,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a project column - * @description Deletes a project column. - */ "projects/delete-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** Update an existing project column */ "projects/update-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89544,6 +97590,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -89553,27 +97602,30 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List project cards - * @description Lists the project cards in a project. - */ "projects/list-cards": { parameters: { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-card"][]; @@ -89584,25 +97636,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Create a project card */ "projects/create-card": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** * @description The project card's note * @example Update all gems */ note: string | null; - }, - { + } + | { /** * @description The unique identifier of the content associated with the card * @example 42 @@ -89613,14 +97667,15 @@ export interface operations { * @example PullRequest */ content_type: string; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-card"]; }; @@ -89630,6 +97685,9 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Validation failed */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["validation-error"] @@ -89638,6 +97696,9 @@ export interface operations { }; /** @description Response */ 503: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { code?: string; @@ -89652,12 +97713,15 @@ export interface operations { }; }; }; - /** Move a project column */ "projects/move-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the column. */ column_id: components["parameters"]["column-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89673,6 +97737,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": Record; }; @@ -89683,19 +97750,23 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -89705,25 +97776,32 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ "projects/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Delete Success */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -89736,15 +97814,15 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89777,6 +97855,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -89785,6 +97866,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Forbidden */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -89795,33 +97879,39 @@ export interface operations { }; /** @description Not Found if the authenticated user does not have access to the project */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 410: components["responses"]["gone"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ "projects/list-collaborators": { parameters: { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -89834,16 +97924,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ "projects/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -89861,7 +97952,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -89870,21 +97964,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ "projects/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -89893,20 +97992,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ "projects/get-permission-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-collaborator-permission"]; }; @@ -89918,25 +98022,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List project columns - * @description Lists the project columns in a project. - */ "projects/list-columns": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project-column"][]; @@ -89947,15 +98054,15 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Create a project column - * @description Creates a new project column. - */ "projects/create-column": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -89971,6 +98078,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project-column"]; }; @@ -89981,24 +98091,14 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get rate limit status for the authenticated user - * @description **Note:** Accessing this endpoint does not count against your REST API rate limit. - * - * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." - * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." - * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." - * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." - * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." - * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/overview/api-versions)." - * - * **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - */ "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -90006,6 +98106,7 @@ export interface operations { "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["rate-limit-overview"]; @@ -90015,22 +98116,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a repository - * @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. - * - * **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)." - */ "repos/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -90040,30 +98144,33 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a repository - * @description Deleting a repository requires admin access. - * - * If an organization owner has configured the organization to prevent members from deleting organization-owned - * repositories, you will get a `403 Forbidden` response. - * - * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. - */ "repos/delete": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -90074,16 +98181,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository - * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. - */ "repos/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90096,7 +98204,7 @@ export interface operations { homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. - * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. + * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ private?: boolean; @@ -90105,16 +98213,14 @@ export interface operations { * @enum {string} */ visibility?: "public" | "private"; - /** - * @description Specify which security and analysis features to enable or disable for the repository. + /** @description Specify which security and analysis features to enable or disable for the repository. * - * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." * - * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + * For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + * `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. * - * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - */ + * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ advanced_security?: { @@ -90193,34 +98299,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -90245,6 +98351,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -90255,31 +98364,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List artifacts for a repository - * @description Lists all artifacts for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-artifacts-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90290,129 +98400,143 @@ export interface operations { }; }; }; - /** - * Get an artifact - * @description Gets a specific artifact for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["artifact"]; }; }; }; }; - /** - * Delete an artifact - * @description Deletes an artifact for a workflow run. - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download an artifact - * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in - * the response header to find the URL for the download. The `:archive_format` must be `zip`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-artifact": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the artifact. */ artifact_id: components["parameters"]["artifact-id"]; archive_format: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { Location: components["headers"]["location"]; + [name: string]: unknown; }; - content: never; + content?: never; }; 410: components["responses"]["gone"]; }; }; - /** - * Get GitHub Actions cache usage for a repository - * @description Gets GitHub Actions cache usage for a repository. - * 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. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-usage-by-repository"]; }; }; }; }; - /** - * List GitHub Actions caches for a repository - * @description Lists the GitHub Actions caches for a repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-actions-cache-list": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; + /** @description An explicit key or prefix for identifying the cache */ key?: components["parameters"]["actions-cache-key"]; + /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ sort?: components["parameters"]["actions-cache-list-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["actions-cache-list"]; @@ -90420,119 +98544,128 @@ export interface operations { }; }; }; - /** - * Delete GitHub Actions caches for a repository (using a cache key) - * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-key": { parameters: { query: { + /** @description A key for identifying the cache. */ key: components["parameters"]["actions-cache-key-required"]; + /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - /** - * Delete a GitHub Actions cache for a repository (using a cache ID) - * @description Deletes a GitHub Actions cache for a repository, using a cache ID. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-actions-cache-by-id": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the GitHub Actions cache. */ cache_id: components["parameters"]["cache-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a job for a workflow run - * @description Gets a specific job in a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["job"]; }; }; }; }; - /** - * Download job logs for 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 - * for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-job-logs-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Re-run a job from a workflow run - * @description Re-run a job and its dependent jobs in a workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-job-for-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the job. */ job_id: components["parameters"]["job-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90548,6 +98681,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -90555,22 +98691,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get the customization template for an OIDC subject claim for a repository - * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Status response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["oidc-custom-sub-repo"]; }; @@ -90579,18 +98718,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set the customization template for an OIDC subject claim for a repository - * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-oidc-sub-claim-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90605,6 +98743,9 @@ export interface operations { responses: { /** @description Empty response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -90614,31 +98755,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository organization secrets - * @description Lists all organization secrets shared with a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90649,30 +98789,30 @@ export interface operations { }; }; }; - /** - * List repository organization variables - * @description Lists all organization variables shared with a repository. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-organization-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90683,40 +98823,42 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions permissions for a repository - * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-repository-permissions"]; }; }; }; }; - /** - * Set GitHub Actions permissions for a repository - * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90729,48 +98871,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the level of access for workflows outside of the repository - * @description 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-workflow-access-to-repository"]; }; }; }; }; - /** - * Set the level of access for workflows outside of the repository - * @description 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)". - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-workflow-access-to-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90780,44 +98923,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get allowed actions and reusable workflows for a repository - * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - /** - * Set allowed actions and reusable workflows for a repository - * @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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-allowed-actions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -90827,48 +98975,49 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get default workflow permissions for a repository - * @description Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - * as well as if GitHub Actions can submit approving pull request reviews. - * For 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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - /** - * Set default workflow permissions for a repository - * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - * can submit approving pull request reviews. - * For 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-github-actions-default-workflow-permissions-repository": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90878,40 +99027,46 @@ export interface operations { responses: { /** @description Success response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning organization */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List self-hosted runners for a repository - * @description Lists all self-hosted runners configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-self-hosted-runners-for-repo": { parameters: { query?: { /** @description The name of a self-hosted runner. */ name?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -90922,44 +99077,42 @@ export interface operations { }; }; }; - /** - * List runner applications for a repository - * @description Lists binaries for the runner application that you can download and run. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-runner-applications-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - /** - * Create configuration for a just-in-time runner for a repository - * @description Generates a configuration that can be passed to the runner application at startup. - * - * The authenticated user must have admin access to the repository. - * - * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. - */ "actions/generate-runner-jitconfig-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -90984,151 +99137,141 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - * - * ``` - * ./config.sh --url https://github.com/octo-org --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-registration-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Create a remove token for a repository - * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - * - * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - * - * ``` - * ./config.sh remove --token TOKEN - * ``` - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-remove-token-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - /** - * Get a self-hosted runner for a repository - * @description Gets a specific self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["runner"]; }; }; }; }; - /** - * Delete a self-hosted runner from a repository - * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-self-hosted-runner-from-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a self-hosted runner for a repository - * @description Lists all labels for a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; }; }; - /** - * Set custom labels for a self-hosted runner for a repository - * @description Remove all previous custom labels and set the new custom labels for a specific - * self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/set-custom-labels-for-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91144,21 +99287,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Add custom labels to a self-hosted runner for a repository - * @description Adds custom labels to a self-hosted runner configured in a repository. - * - * Authenticated users must have admin access to the organization to use this endpoint. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/add-custom-labels-to-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91174,89 +99315,89 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Remove all custom labels from a self-hosted runner for a repository - * @description Remove all custom labels from a self-hosted runner configured in a - * repository. Returns the remaining read-only labels from the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels_readonly"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a custom label from a self-hosted runner for a repository - * @description Remove a custom label from a self-hosted runner configured - * in a repository. Returns the remaining labels from the runner. - * - * This endpoint returns a `404 Not Found` status if the custom label is not - * present on the runner. - * - * Authenticated users must have admin access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/remove-custom-label-from-self-hosted-runner-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description Unique identifier of the self-hosted runner. */ runner_id: components["parameters"]["runner-id"]; + /** @description The name of a self-hosted runner's custom label. */ name: components["parameters"]["runner-label-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 200: components["responses"]["actions_runner_labels"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List workflow runs for a repository - * @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/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - * - * This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. - */ "actions/list-workflow-runs-for-repo": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91267,97 +99408,109 @@ export interface operations { }; }; }; - /** - * Get a workflow run - * @description Gets a specific workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * Delete a workflow run - * @description Deletes a specific workflow run. - * - * Anyone with write access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-reviews-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment-approvals"][]; }; }; }; }; - /** - * Approve a workflow run for a fork pull request - * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/approve-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -91366,32 +99519,34 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List workflow run artifacts - * @description Lists artifacts for a workflow run. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-run-artifacts": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91402,62 +99557,66 @@ export interface operations { }; }; }; - /** - * Get a workflow run attempt - * @description Gets a specific workflow run attempt. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run-attempt": { parameters: { query?: { + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - /** - * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91469,52 +99628,56 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download workflow run attempt logs - * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-attempt-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; + /** @description The attempt number of the workflow run. */ attempt_number: components["parameters"]["attempt-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Cancel a workflow run - * @description Cancels a workflow run using its `id`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -91522,22 +99685,19 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Review custom deployment protection rules for a workflow run - * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * **Note:** GitHub Apps can only review their own custom deployment protection rules. - * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/review-custom-gates-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91549,28 +99709,34 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Force cancel a workflow run - * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. - * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/force-cancel-workflow-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; @@ -91578,34 +99744,34 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List jobs for a workflow run - * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information - * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-jobs-for-workflow-run": { parameters: { query?: { /** @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. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91616,97 +99782,100 @@ export interface operations { }; }; }; - /** - * Download workflow run logs - * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/download-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Delete workflow run logs - * @description Deletes all logs for a workflow run. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-workflow-run-logs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 500: components["responses"]["internal_error"]; }; }; - /** - * Get pending deployments for a workflow run - * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pending-deployment"][]; }; }; }; }; - /** - * Review pending deployments for a workflow run - * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. - * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/review-pending-deployments-for-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -91714,9 +99883,9 @@ export interface operations { /** * @description The list of environment ids to approve or reject * @example [ - * 161171787, - * 161171795 - * ] + * 161171787, + * 161171795 + * ] */ environment_ids: number[]; /** @@ -91736,25 +99905,28 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"][]; }; }; }; }; - /** - * Re-run a workflow - * @description Re-runs your workflow run using its `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -91770,25 +99942,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/re-run-workflow-failed-jobs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -91804,62 +99979,66 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get workflow run usage - * @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)". - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-run-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the workflow run. */ run_id: components["parameters"]["run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-run-usage"]; }; }; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -91870,72 +100049,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -91950,63 +100128,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository variables - * @description Lists all repository variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-repo-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -92017,20 +100203,17 @@ export interface operations { }; }; }; - /** - * Create a repository variable - * @description Creates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92045,75 +100228,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get a repository variable - * @description Gets a specific variable in a repository. - * - * The authenticated user must have collaborator access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete a repository variable - * @description Deletes a repository variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a repository variable - * @description Updates a repository variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-repo-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -92128,34 +100316,37 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository workflows - * @description Lists the workflows in a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-repo-workflows": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -92166,68 +100357,71 @@ export interface operations { }; }; }; - /** - * Get a workflow - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow"]; }; }; }; }; - /** - * Disable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/disable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * 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`. - * - * You 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)." - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-workflow-dispatch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -92244,64 +100438,80 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable a workflow - * @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`. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/enable-workflow": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List workflow runs for a workflow - * @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/guides/getting-started-with-the-rest-api#parameters). - * - * Anyone with read access to the repository can use this endpoint - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/list-workflow-runs": { parameters: { query?: { + /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ actor?: components["parameters"]["actor"]; + /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ branch?: components["parameters"]["workflow-run-branch"]; + /** @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)." */ event?: components["parameters"]["event"]; + /** @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 Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @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)." */ created?: components["parameters"]["created"]; + /** @description If `true` pull requests are omitted from the response (empty array). */ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + /** @description Returns workflow runs with the `check_suite_id` that you specify. */ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ head_sha?: components["parameters"]["workflow-run-head-sha"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -92312,66 +100522,57 @@ export interface operations { }; }; }; - /** - * Get workflow usage - * @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)". - * - * 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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "actions/get-workflow-usage": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ workflow_id: components["parameters"]["workflow-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["workflow-usage"]; }; }; }; }; - /** - * List repository activities - * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. - * - * For more information about viewing repository activity, - * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." - */ "repos/list-activities": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; - /** - * @description The Git reference for the activities you want to list. + /** @description The Git reference for the activities you want to list. * - * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. - */ + * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. */ ref?: string; /** @description The GitHub username to use to filter by the actor who performed the activity. */ actor?: string; - /** - * @description The time period to filter by. + /** @description The time period to filter by. * - * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). - */ + * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). */ time_period?: "day" | "week" | "month" | "quarter" | "year"; - /** - * @description The activity type to filter by. + /** @description The activity type to filter by. * - * For example, you can choose to filter by "force_push", to see all force pushes to the repository. - */ + * For example, you can choose to filter by "force_push", to see all force pushes to the repository. */ activity_type?: | "push" | "force_push" @@ -92380,16 +100581,22 @@ export interface operations { | "pr_merge" | "merge_queue_merge"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["activity"][]; @@ -92398,26 +100605,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List assignees - * @description Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. - */ "issues/list-assignees": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -92426,67 +100637,75 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user can be assigned - * @description Checks if a user has permission to be assigned to an issue in this repository. - * - * If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. - * - * Otherwise a `404` status code is returned. - */ "issues/check-user-can-be-assigned": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Otherwise a `404` status code is returned. */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Get all autolinks of a repository - * @description Gets all autolinks that are configured for a repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/list-autolinks": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"][]; }; }; }; }; - /** - * Create an autolink reference for a repository - * @description Users with admin access to the repository can create an autolink. - */ "repos/create-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -92509,6 +100728,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["autolink"]; @@ -92517,23 +100737,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an autolink reference of a repository - * @description This returns a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/get-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["autolink"]; }; @@ -92541,107 +100765,136 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an autolink reference from a repository - * @description This deletes a single autolink reference by ID that was configured for the given repository. - * - * Information about autolinks are only available to repository administrators. - */ "repos/delete-autolink": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the autolink. */ autolink_id: components["parameters"]["autolink-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Check if automated security fixes are enabled for a repository - * @description Shows whether automated security fixes are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". - */ "repos/check-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if dependabot is enabled */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; /** @description Not Found if dependabot is not enabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable automated security fixes - * @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)". - */ "repos/enable-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable 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/articles/configuring-automated-security-fixes)". - */ "repos/disable-automated-security-fixes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List branches */ "repos/list-branches": { parameters: { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-branch"][]; @@ -92650,18 +100903,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get a branch */ "repos/get-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -92670,21 +100932,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get branch protection - * @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. - */ "repos/get-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-protection"]; }; @@ -92692,23 +100960,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update branch protection - * @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. - * - * Protecting a branch requires admin or owner permissions to the repository. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - * - * **Note**: The list of users, apps, and teams in total is limited to 100 items. - */ "repos/update-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -92720,6 +100984,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -92799,6 +101064,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch"]; }; @@ -92808,148 +101076,178 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete branch protection - * @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. - */ "repos/delete-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; }; }; - /** - * Get admin branch protection - * @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. - */ "repos/get-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Set admin branch protection - * @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. - * - * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/set-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - /** - * Delete admin branch protection - * @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. - * - * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/delete-admin-branch-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get pull request review protection - * @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. - */ "repos/get-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - /** - * Delete pull request review protection - * @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. - */ "repos/delete-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update pull request review protection - * @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. - * - * Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. - * - * **Note**: Passing new arrays of `users` and `teams` replaces their previous values. - */ "repos/update-pull-request-review-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -92989,6 +101287,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; @@ -92996,25 +101297,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get commit signature protection - * @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. - * - * When 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. - * - * **Note**: You must enable branch protection to require signed commits. - */ "repos/get-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -93022,23 +101325,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create commit signature protection - * @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. - * - * When 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. - */ "repos/create-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; @@ -93046,43 +101353,53 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete commit signature protection - * @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. - * - * When 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. - */ "repos/delete-commit-signature-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get status checks protection - * @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. - */ "repos/get-status-checks-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -93090,38 +101407,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Remove status check protection - * @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. - */ "repos/remove-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update status check protection - * @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. - * - * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. - */ "repos/update-status-check-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93131,6 +101454,7 @@ export interface operations { /** * @deprecated * @description **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. + * */ contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ @@ -93146,6 +101470,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["status-check-policy"]; }; @@ -93154,21 +101481,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all status check contexts - * @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. - */ "repos/get-all-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -93176,17 +101509,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set status check contexts - * @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. - */ "repos/set-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93199,6 +101534,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -93207,17 +101545,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add status check contexts - * @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. - */ "repos/add-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93230,6 +101570,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -93239,17 +101582,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove status check contexts - * @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. - */ "repos/remove-status-check-contexts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93262,6 +101607,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -93270,25 +101618,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get 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. - * - * Lists who has access to this protected branch. - * - * **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. - */ "repos/get-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-restriction-policy"]; }; @@ -93296,44 +101646,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete 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. - * - * Disables the ability to restrict who can push to this branch. - */ "repos/delete-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get apps with access to the protected branch - * @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. - * - * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/get-apps-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -93341,19 +101699,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * 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 GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/set-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93366,6 +101724,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -93373,19 +101734,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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. - * - * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/add-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93398,6 +101759,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -93405,19 +101769,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * 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. - * - * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. - */ "repos/remove-app-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93430,6 +101794,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["integration"][]; }; @@ -93437,23 +101804,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get teams with access to the protected branch - * @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. - * - * Lists the teams who have push access to this branch. The list includes child teams. - */ "repos/get-teams-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -93461,19 +101832,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Replaces 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. - */ "repos/set-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93486,6 +101857,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -93493,19 +101867,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Grants the specified teams push access for this branch. You can also give push access to child teams. - */ "repos/add-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93518,6 +101892,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -93525,19 +101902,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove team access restrictions - * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Removes the ability of a team to push to this branch. You can also remove push access for child teams. - */ "repos/remove-team-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93550,6 +101927,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team"][]; }; @@ -93557,23 +101937,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get users with access to the protected branch - * @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. - * - * Lists the people who have push access to this branch. - */ "repos/get-users-with-access-to-protected-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -93581,23 +101965,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Set user 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. - * - * Replaces 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. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/set-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93610,6 +101990,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -93617,23 +102000,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add user 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. - * - * Grants the specified people push access for this branch. - * - * | Type | Description | - * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/add-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93646,6 +102025,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -93653,23 +102035,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove user 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. - * - * Removes the ability of a user to push to this branch. - * - * | Type | Description | - * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | - * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | - */ "repos/remove-user-access-restrictions": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody?: { content: { @@ -93682,6 +102060,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -93689,23 +102070,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Rename a branch - * @description Renames a branch in a repository. - * - * **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)". - * - * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - * - * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. - */ "repos/rename-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; requestBody: { content: { @@ -93718,6 +102095,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-with-protection"]; }; @@ -93727,20 +102107,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. - * - * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. - */ "checks/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -93766,7 +102143,7 @@ export interface operations { started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ conclusion?: @@ -93825,155 +102202,7 @@ export interface operations { caption?: string; }[]; }; - /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ - actions?: { - /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - label: string; - /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - description: string; - /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - identifier: string; - }[]; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; - }; - /** - * Get a check run - * @description Gets a single check run using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ - "checks/get": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - check_run_id: components["parameters"]["check-run-id"]; - }; - }; - responses: { - /** @description Response */ - 200: { - content: { - "application/json": components["schemas"]["check-run"]; - }; - }; - }; - }; - /** - * Update a check run - * @description Updates a check run for a specific commit in a repository. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ - "checks/update": { - parameters: { - path: { - owner: components["parameters"]["owner"]; - repo: components["parameters"]["repo"]; - check_run_id: components["parameters"]["check-run-id"]; - }; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the check. For example, "code-coverage". */ - name?: string; - /** @description The URL of the integrator's site that has the full details of the check. */ - details_url?: string; - /** @description A reference for the run on the integrator's system. */ - external_id?: string; - /** - * Format: date-time - * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - started_at?: string; - /** - * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. - * @enum {string} - */ - status?: - | "queued" - | "in_progress" - | "completed" - | "waiting" - | "requested" - | "pending"; - /** - * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. - * @enum {string} - */ - conclusion?: - | "action_required" - | "cancelled" - | "failure" - | "neutral" - | "success" - | "skipped" - | "stale" - | "timed_out"; - /** - * Format: date-time - * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - completed_at?: string; - /** @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. */ - output?: { - /** @description **Required**. */ - title?: string; - /** @description Can contain Markdown. */ - summary: string; - /** @description Can contain Markdown. */ - text?: string; - /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */ - annotations?: { - /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - path: string; - /** @description The start line of the annotation. Line numbers start at 1. */ - start_line: number; - /** @description The end line of the annotation. */ - end_line: number; - /** @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. */ - start_column?: number; - /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - end_column?: number; - /** - * @description The level of the annotation. - * @enum {string} - */ - annotation_level: "notice" | "warning" | "failure"; - /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - message: string; - /** @description The title that represents the annotation. The maximum size is 255 characters. */ - title?: string; - /** @description Details about this annotation. The maximum size is 64 KB. */ - raw_details?: string; - }[]; - /** @description Adds images to the output displayed in the GitHub pull request UI. */ - images?: { - /** @description The alternative text for the image. */ - alt: string; - /** @description The full URL of the image. */ - image_url: string; - /** @description A short image description. */ - caption?: string; - }[]; - }; - /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/reference/checks#check-runs-and-requested-actions)." */ actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; @@ -93982,7 +102211,159 @@ export interface operations { /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ identifier: string; }[]; - } & ( + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + }; + "checks/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ + check_run_id: components["parameters"]["check-run-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["check-run"]; + }; + }; + }; + }; + "checks/update": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The account owner of the repository. The name is not case sensitive. */ + owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ + repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ + check_run_id: components["parameters"]["check-run-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": + | { + /** @description The name of the check. For example, "code-coverage". */ + name?: string; + /** @description The URL of the integrator's site that has the full details of the check. */ + details_url?: string; + /** @description A reference for the run on the integrator's system. */ + external_id?: string; + /** + * Format: date-time + * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + started_at?: string; + /** + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. + * @enum {string} + */ + status?: + | "queued" + | "in_progress" + | "completed" + | "waiting" + | "requested" + | "pending"; + /** + * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. + * @enum {string} + */ + conclusion?: + | "action_required" + | "cancelled" + | "failure" + | "neutral" + | "success" + | "skipped" + | "stale" + | "timed_out"; + /** + * Format: date-time + * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + completed_at?: string; + /** @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. */ + output?: { + /** @description **Required**. */ + title?: string; + /** @description Can contain Markdown. */ + summary: string; + /** @description Can contain Markdown. */ + text?: string; + /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */ + annotations?: { + /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ + path: string; + /** @description The start line of the annotation. Line numbers start at 1. */ + start_line: number; + /** @description The end line of the annotation. */ + end_line: number; + /** @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. */ + start_column?: number; + /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ + end_column?: number; + /** + * @description The level of the annotation. + * @enum {string} + */ + annotation_level: "notice" | "warning" | "failure"; + /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ + message: string; + /** @description The title that represents the annotation. The maximum size is 255 characters. */ + title?: string; + /** @description Details about this annotation. The maximum size is 64 KB. */ + raw_details?: string; + }[]; + /** @description Adds images to the output displayed in the GitHub pull request UI. */ + images?: { + /** @description The alternative text for the image. */ + alt: string; + /** @description The full URL of the image. */ + image_url: string; + /** @description A short image description. */ + caption?: string; + }[]; + }; + /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ + actions?: { + /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ + label: string; + /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ + description: string; + /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ + identifier: string; + }[]; + } | { /** @enum {unknown} */ status?: "completed"; @@ -93992,42 +102373,47 @@ export interface operations { /** @enum {unknown} */ status?: "queued" | "in_progress"; [key: string]: unknown; - } - ); + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-run"]; }; }; }; }; - /** - * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-annotations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["check-annotation"][]; @@ -94035,31 +102421,36 @@ export interface operations { }; }; }; - /** - * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-run": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check run. */ check_run_id: components["parameters"]["check-run-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -94067,26 +102458,26 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Create a check suite - * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/create-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94099,29 +102490,35 @@ export interface operations { responses: { /** @description Response when the suite already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). - * You must have admin permissions in the repository to set preferences for check suites. - */ "checks/set-suites-preferences": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94142,66 +102539,74 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - /** - * Get a check suite - * @description Gets a single check suite using its `id`. - * - * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/get-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["check-suite"]; }; }; }; }; - /** - * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-suite": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -94212,64 +102617,69 @@ export interface operations { }; }; }; - /** - * Rerequest a check suite - * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. - */ "checks/rerequest-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the check suite. */ check_suite_id: components["parameters"]["check-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * List code scanning alerts for a repository - * @description Lists all open code scanning alerts for the default branch (usually `main` - * or `master`). 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. - * - * The response includes a `most_recent_instance` object. - * This provides details of the most recent instance of this alert - * for the default branch or for the specified Git reference - * (if you used `ref` in the request). - */ "code-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. . `number` is deprecated - we recommend that you use `created` instead. */ sort?: "created" | "number" | "updated"; /** @description Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ state?: components["schemas"]["code-scanning-alert-state"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-items"][]; }; @@ -94280,23 +102690,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning alert - * @description Gets a single code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -94307,18 +102721,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning alert - * @description Updates the status of a single code scanning alert. - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -94332,6 +102747,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert"]; }; @@ -94341,28 +102759,34 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List instances of a code scanning alert - * @description Lists all instances of the specified code scanning alert. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-alert-instances": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-alert-instance"][]; }; @@ -94372,47 +102796,42 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List code scanning analyses for a repository - * @description Lists the details of all code scanning analyses for a repository, - * starting with the most recent. - * The response is paginated and you can use the `page` and `per_page` parameters - * to list the analyses you're interested in. - * By default 30 analyses are listed per page. - * - * The `rules_count` field in the response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * **Deprecation notice**: - * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-recent-analyses": { parameters: { query?: { + /** @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. */ tool_name?: components["parameters"]["tool-name"]; + /** @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. */ tool_guid?: components["parameters"]["tool-guid"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The Git reference for the analyses 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`. */ ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ sort?: "created"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"][]; }; @@ -94422,38 +102841,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning analysis for a repository - * @description Gets a specified code scanning analysis for a repository. - * - * The default JSON response contains fields that describe the analysis. - * This includes the Git reference and commit SHA to which the analysis relates, - * the datetime of the analysis, the name of the code scanning tool, - * and the number of alerts. - * - * The `rules_count` field in the default response give the number of rules - * that were run in the analysis. - * For very old analyses this data is not available, - * and `0` is returned in this field. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-analysis": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; "application/json+sarif": { @@ -94466,89 +102874,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. - * - * You can delete one analysis at a time. - * To delete a series of analyses, start with the most recent analysis and work backwards. - * Conceptually, the process is similar to the undo function in a text editor. - * - * When you list the analyses for a repository, - * one or more will be identified as deletable in the response: - * - * ``` - * "deletable": true - * ``` - * - * An analysis is deletable when it's the most recent in a set of analyses. - * Typically, a repository will have multiple sets of analyses - * for each enabled code scanning tool, - * where a set is determined by a unique combination of analysis values: - * - * * `ref` - * * `tool` - * * `category` - * - * If you attempt to delete an analysis that is not the most recent in a set, - * you'll get a 400 response with the message: - * - * ``` - * Analysis specified is not deletable. - * ``` - * - * The response from a successful `DELETE` operation provides you with - * two alternative URLs for deleting the next analysis in the set: - * `next_analysis_url` and `confirm_delete_url`. - * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis - * in a set. This is a useful option if you want to preserve at least one analysis - * for the specified tool in your repository. - * Use the `confirm_delete_url` URL if you are content to remove all analyses for a tool. - * When you delete the last analysis in a set, the value of `next_analysis_url` and `confirm_delete_url` - * in the 200 response is `null`. - * - * As an example of the deletion process, - * let's imagine that you added a workflow that configured a particular code scanning tool - * to analyze the code in a repository. This tool has added 15 analyses: - * 10 on the default branch, and another 5 on a topic branch. - * You therefore have two separate sets of analyses for this tool. - * You've now decided that you want to remove all of the analyses for the tool. - * To do this you must make 15 separate deletion requests. - * To start, you must find an analysis that's identified as deletable. - * Each set of analyses always has one that's identified as deletable. - * Having found the deletable analysis for one of the two sets, - * delete this analysis and then continue deleting the next analysis in the set until they're all deleted. - * Then repeat the process for the second set. - * The procedure therefore consists of a nested loop: - * - * **Outer loop**: - * * List the analyses for the repository, filtered by tool. - * * Parse this list to find a deletable analysis. If found: - * - * **Inner loop**: - * * Delete the identified analysis. - * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. - * - * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/delete-analysis": { parameters: { query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ confirm_delete?: string | null; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ analysis_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; @@ -94559,22 +102908,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CodeQL databases for a repository - * @description Lists the CodeQL databases that are available in a repository. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/list-codeql-databases": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-codeql-database"][]; }; @@ -94584,30 +102936,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a CodeQL database for a repository - * @description Gets a CodeQL database for a language in a repository. - * - * By default this endpoint returns JSON metadata about the CodeQL database. To - * download the CodeQL database binary content, set the `Accept` header of the request - * to [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure - * your HTTP client is configured to follow redirects or use the `Location` header - * to make a second request to get the redirect URL. - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-codeql-database": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The language of the CodeQL database. */ language: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-codeql-database"]; }; @@ -94618,22 +102967,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a code scanning default setup configuration - * @description Gets a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup"]; }; @@ -94643,18 +102995,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a code scanning default setup configuration - * @description Updates a code scanning default setup configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/update-default-setup": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94664,12 +103015,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; @@ -94680,47 +103037,17 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." - * - * There are two places where you can upload code scanning results. - * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." - * - 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)." - * - * You 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: - * - * ``` - * 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. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." - * - * - * | **SARIF data** | **Maximum values** | **Additional limits** | - * |----------------------------------|:------------------:|----------------------------------------------------------------------------------| - * | Runs per file | 20 | | - * | 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. - * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/upload-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94731,7 +103058,7 @@ export interface operations { /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. - * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. + * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ checkout_uri?: string; @@ -94742,10 +103069,8 @@ export interface operations { started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ tool_name?: string; - /** - * @description Whether the SARIF file will be validated according to the code scanning specifications. - * This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. - */ + /** @description Whether the SARIF file will be validated according to the code scanning specifications. + * This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. */ validate?: boolean; }; }; @@ -94753,40 +103078,53 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ 413: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. - */ "code-scanning/get-sarif": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ sarif_id: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; @@ -94794,63 +103132,73 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List CODEOWNERS errors - * @description List any syntax errors that are detected in the CODEOWNERS - * file. - * - * For more information about the correct CODEOWNERS syntax, - * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." - */ "repos/codeowners-errors": { parameters: { query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List codespaces in a repository for the authenticated user - * @description Lists the codespaces associated to a specified repository and the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/list-in-repository-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -94864,18 +103212,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a codespace in a repository - * @description Creates a codespace owned by the authenticated user in the specified repository. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/create-with-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -94911,12 +103258,18 @@ export interface operations { responses: { /** @description Response when the codespace was successfully created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -94928,27 +103281,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List devcontainer configurations in a repository for the authenticated user - * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files - * specify launchpoint configurations for codespaces created within the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/list-devcontainers-in-repository-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -94967,12 +103323,6 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List available machine types for a repository - * @description List the machine types available for a given repository based on its configuration. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/repo-machines-for-authenticated-user": { parameters: { query?: { @@ -94983,14 +103333,22 @@ export interface operations { /** @description The branch or commit to check for prebuild availability and devcontainer restrictions. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -95005,12 +103363,6 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get default attributes for a codespace - * @description Gets the default attributes for codespaces created by the user with the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/pre-flight-with-repo-for-authenticated-user": { parameters: { query?: { @@ -95019,14 +103371,22 @@ export interface operations { /** @description An alternative IP for default location auto-detection, such as when proxying a request. */ client_ip?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when a user is able to create codespaces from the repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { billable_owner?: components["schemas"]["simple-user"]; @@ -95042,12 +103402,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if permissions defined by a devcontainer have been accepted by the authenticated user - * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/check-permissions-for-devcontainer": { parameters: { query: { @@ -95056,14 +103410,22 @@ export interface operations { /** @description Path to the devcontainer.json configuration to use for the permission check. */ devcontainer_path: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response when the permission check is successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; }; @@ -95075,29 +103437,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository secrets - * @description Lists all development environment secrets available in a repository without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -95108,68 +103471,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository development environment secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repo-codespaces-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -95184,48 +103550,47 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a development environment secret in a repository using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "codespaces/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository collaborators - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/list-collaborators": { parameters: { query?: { @@ -95233,19 +103598,27 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["collaborator"][]; @@ -95254,66 +103627,51 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is a repository collaborator - * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * - * Team members will include the members of child teams. - * - * The authenticated user must have push access to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. - */ "repos/check-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if user is a collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if user is not a collaborator */ 404: { - content: never; - }; - }; - }; - /** - * Add a repository collaborator - * @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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * 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)." - * - * 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: - * - * ``` - * Cannot assign {member} permission of {role name} - * ``` - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). - * - * **Updating an existing collaborator's permission level** - * - * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. - * - * **Rate limits** - * - * You 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. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/add-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -95329,85 +103687,75 @@ export interface operations { responses: { /** @description Response when a new invitation is created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; - /** - * @description Response when: - * - an existing collaborator is added as a collaborator - * - an organization member is added as an individual collaborator - * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator - */ + /** @description Response when: + * - an existing collaborator is added as a collaborator + * - an organization member is added as an individual collaborator + * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository collaborator - * @description Removes a collaborator from a repository. - * - * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. - * - * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues - * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - * - Unstars the repository - * - Updates access permissions to packages - * - * Removing a user as a collaborator has the following effects on forks: - * - If the user had access to a fork through their membership to this repository, the user will also be removed from the fork. - * - If the user had their own fork of the repository, the fork will be deleted. - * - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. - * - * **Note**: A user can still have access to the repository through organization permissions like base repository permissions. - * - * Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. - * - * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". - */ "repos/remove-collaborator": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when collaborator was removed from the repository. */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ "repos/get-collaborator-permission-level": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user has admin permissions */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-collaborator-permission"]; }; @@ -95415,33 +103763,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit comments for a repository - * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-commit-comments-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -95449,28 +103794,27 @@ export interface operations { }; }; }; - /** - * Get a commit comment - * @description Gets a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/get-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -95478,41 +103822,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a commit comment */ "repos/delete-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a commit comment - * @description Updates the contents of a specified commit comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/update-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95525,6 +103873,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comment"]; }; @@ -95532,10 +103883,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for a commit comment - * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). - */ "reactions/list-for-commit-comment": { parameters: { query?: { @@ -95549,20 +103896,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -95571,17 +103927,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a commit comment - * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. - */ "reactions/create-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -95605,12 +103963,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -95618,59 +103982,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a commit comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). - */ "reactions/delete-for-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List commits - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "repos/list-commits": { parameters: { query?: { @@ -95682,22 +104020,31 @@ export interface operations { author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ committer?: string; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -95709,23 +104056,27 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List branches for HEAD commit - * @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. - * - * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. - */ "repos/list-branches-for-head-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["branch-short"][]; }; @@ -95734,34 +104085,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List commit comments - * @description Lists the comments for a specified commit. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/list-comments-for-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"][]; @@ -95769,26 +104118,19 @@ export interface operations { }; }; }; - /** - * Create a commit comment - * @description 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "repos/create-commit-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; requestBody: { content: { @@ -95810,6 +104152,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit-comment"]; @@ -95819,29 +104162,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. - * - * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. - */ "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -95850,62 +104196,32 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a commit - * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - * - * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." Pagination query parameters are not supported for these media types. - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. - * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/get-commit": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; @@ -95917,38 +104233,39 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - * - * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-for-ref": { parameters: { query?: { + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description Returns check runs with the specified `status`. */ status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; app_id?: number; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -95959,14 +104276,6 @@ export interface operations { }; }; }; - /** - * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. - * - * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. - */ "checks/list-suites-for-ref": { parameters: { query?: { @@ -95975,21 +104284,31 @@ export interface operations { * @example 1 */ app_id?: number; + /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96000,32 +104319,32 @@ export interface operations { }; }; }; - /** - * Get the combined status for a specific reference - * @description Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. - * - * - * Additionally, a combined `state` is returned. The `state` is one of: - * - * * **failure** if any of the contexts report as `error` or `failure` - * * **pending** if there are no statuses or a context is `pending` - * * **success** if the latest status for all contexts is `success` - */ "repos/get-combined-status-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-commit-status"]; }; @@ -96033,29 +104352,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commit statuses for a reference - * @description Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one. - * - * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. - */ "repos/list-commit-statuses-for-ref": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ ref: components["parameters"]["commit-ref"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"][]; @@ -96064,105 +104386,57 @@ export interface operations { 301: components["responses"]["moved_permanently"]; }; }; - /** - * Get community profile metrics - * @description Returns all community profile metrics for a repository. The repository 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, - * README, and CONTRIBUTING files. - * - * The `health_percentage` score is defined as a percentage of how many of - * the recommended community health files are present. For more information, see - * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." - * - * `content_reports_enabled` is only returned for organization-owned repositories. - */ "repos/get-community-profile-metrics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["community-profile"]; }; }; }; }; - /** - * Compare two commits - * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs 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)." - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.diff`**: Returns the diff of the commit. - * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. - * - * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. - * - * When calling this endpoint without any paging parameter (`per_page` or `page`), the returned list is limited to 250 commits, and the last commit in the list is the most recent of the entire comparison. - * - * **Working with large comparisons** - * - * 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. - * - * 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)." - * - * **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: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits-with-basehead": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @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`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; @@ -96172,50 +104446,30 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents for files and symlinks. - * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. - * - * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. - * - * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. - * - * **Notes**: - * - * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve - * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). - * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * - If the requested file's size is: - * - 1 MB or smaller: All features of this endpoint are supported. - * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty - * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * - Greater than 100 MB: This endpoint is not supported. - */ "repos/get-content": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/vnd.github.object": components["schemas"]["content-tree"]; "application/json": @@ -96230,22 +104484,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. - * - * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. - */ "repos/create-or-update-file-contents": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -96282,12 +104533,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -96297,26 +104554,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a file - * @description Deletes a file in a repository. - * - * You can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author. - * - * The `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used. - * - * You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. - * - * **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. - */ "repos/delete-file": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description path parameter */ path: string; }; + cookie?: never; }; requestBody: { content: { @@ -96347,6 +104597,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["file-commit"]; }; @@ -96357,30 +104610,32 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository contributors - * @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. - * - * 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. - */ "repos/list-contributors": { parameters: { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If repository contains content */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["contributor"][]; @@ -96388,26 +104643,41 @@ export interface operations { }; /** @description Response if repository is empty */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List Dependabot alerts for a repository - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/list-alerts-for-repo": { parameters: { query?: { + /** @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` */ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; + /** @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. */ sort?: components["parameters"]["dependabot-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** * @deprecated @@ -96419,19 +104689,35 @@ export interface operations { * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. + * This parameter must not be used in combination with `last`. + * Instead, use `per_page` in combination with `after` to fetch the first page of results. */ first?: components["parameters"]["pagination-first"]; + /** @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. + * This parameter must not be used in combination with `first`. + * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"][]; }; @@ -96443,21 +104729,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a Dependabot alert - * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -96467,26 +104762,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a Dependabot alert - * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - * - * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "dependabot/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["dependabot-alert-number"]; }; + cookie?: never; }; requestBody: { content: { "application/json": { /** * @description The state of the Dependabot alert. - * A `dismissed_reason` must be provided when setting the state to `dismissed`. + * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ state: "dismissed" | "open"; @@ -96508,6 +104806,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-alert"]; }; @@ -96519,29 +104820,30 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted - * values. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/list-repo-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -96552,67 +104854,71 @@ export interface operations { }; }; }; - /** - * Get a repository public key - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. - */ "dependabot/get-repo-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - /** - * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/get-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["dependabot-secret"]; }; }; }; }; - /** - * Create or update a repository secret - * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/create-or-update-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -96627,58 +104933,71 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependabot/delete-repo-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a diff of the dependencies between commits - * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. - */ "dependency-graph/diff-range": { parameters: { query?: { + /** @description The full path, relative to the repository root, of the dependency manifest file. */ name?: components["parameters"]["manifest-path"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */ basehead: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-diff"]; @@ -96688,22 +105007,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Export a software bill of materials (SBOM) for a repository. - * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. - */ "dependency-graph/export-sbom": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; @@ -96713,20 +105035,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. - * - * The authenticated user must have access to the repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "dependency-graph/create-repository-snapshot": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96736,6 +105055,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description ID of the created snapshot. */ @@ -96751,10 +105073,6 @@ export interface operations { }; }; }; - /** - * List deployments - * @description Simple filtering of deployments is available via query parameters: - */ "repos/list-deployments": { parameters: { query?: { @@ -96765,20 +105083,28 @@ export interface operations { /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - environment?: string | null; + environment?: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment"][]; @@ -96786,63 +105112,17 @@ export interface operations { }; }; }; - /** - * Create a deployment - * @description Deployments offer a few configurable parameters with certain defaults. - * - * The `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them - * before we merge a pull request. - * - * The `environment` parameter allows deployments to be issued to different runtime environments. Teams often have - * multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter - * makes it easier to track which environments have requested deployments. The default environment is `production`. - * - * The `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If - * the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, - * the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will - * return a failure response. - * - * By default, [commit statuses](https://docs.github.com/rest/commits/statuses) for every submitted context must be in a `success` - * state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to - * specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do - * not require any contexts or create any commit statuses, the deployment will always succeed. - * - * The `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text - * field that will be passed on when a deployment event is dispatched. - * - * The `task` parameter is used by the deployment system to allow different execution paths. In the web world this might - * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an - * application with debugging enabled. - * - * Merged branch response: - * - * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating - * a deployment. This auto-merge happens when: - * * Auto-merge option is enabled in the repository - * * Topic branch does not include the latest changes on the base branch, which is `master` in the response example - * * There are no merge conflicts - * - * If there are no new commits in the base branch, a new request to create a deployment should give a successful - * response. - * - * Merge conflict response: - * - * This error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't - * be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts. - * - * Failed commit status checks: - * - * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` - * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -96861,14 +105141,11 @@ export interface operations { auto_merge?: boolean; /** @description The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ required_contexts?: string[]; - payload?: OneOf< - [ - { + payload?: + | { [key: string]: unknown; - }, - string, - ] - >; + } + | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production @@ -96892,12 +105169,18 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -96906,23 +105189,35 @@ export interface operations { }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** Get a deployment */ "repos/get-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment"]; }; @@ -96930,57 +105225,59 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * To set a deployment as inactive, you must: - * - * * Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment. - * * Mark the active deployment as inactive by adding any non-successful deployment status. - * - * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. - */ "repos/delete-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List deployment statuses - * @description Users with pull access can view deployment statuses for a deployment: - */ "repos/list-deployment-statuses": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"][]; @@ -96989,19 +105286,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a deployment status - * @description Users with `push` access can create deployment statuses for a given deployment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. - */ "repos/create-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97051,6 +105348,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deployment-status"]; @@ -97059,22 +105357,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a deployment status - * @description Users with pull access can view a deployment status for a deployment: - */ "repos/get-deployment-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description deployment_id parameter */ deployment_id: components["parameters"]["deployment-id"]; status_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-status"]; }; @@ -97082,22 +105386,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository dispatch event - * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." - * - * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - * - * This input example shows how you can use the `client_payload` as a test to debug your workflow. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-dispatch-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97114,34 +105413,39 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List environments - * @description Lists the environments for a repository. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-environments": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -97155,48 +105459,46 @@ export interface operations { }; }; }; - /** - * Get an environment - * @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)." - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; }; }; - /** - * Create or update an environment - * @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)." - * - * **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." - * - * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-or-update-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97221,60 +105523,75 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Delete an environment - * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-an-environment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List deployment branch policies - * @description Lists the deployment branch policies for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-deployment-branch-policies": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -97288,19 +105605,19 @@ export interface operations { }; }; }; - /** - * Create a deployment branch policy - * @description Creates a deployment branch or tag policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -97310,60 +105627,73 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ 303: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a deployment branch policy - * @description Gets a deployment branch or tag policy for an environment. - * - * Anyone with read access to the repository can use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Update a deployment branch policy - * @description Updates a deployment branch or tag policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -97373,53 +105703,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - /** - * Delete a deployment branch policy - * @description Deletes a deployment branch or tag policy for an environment. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-deployment-branch-policy": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-all-deployment-protection-rules": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description List of deployment protection rules */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -97433,23 +105773,19 @@ export interface operations { }; }; }; - /** - * Create a custom deployment protection rule on an environment - * @description Enable a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; requestBody: { content: { @@ -97462,37 +105798,41 @@ export interface operations { responses: { /** @description The enabled custom deployment protection rule */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. - * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/list-custom-deployment-rule-integrations": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description A list of custom deployment rule integrations available for this environment. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @@ -97506,82 +105846,88 @@ export interface operations { }; }; }; - /** - * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." - * - * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. - */ "repos/get-custom-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - /** - * Disable a custom protection rule for an environment - * @description Disables a custom deployment protection rule for an environment. - * - * The authenticated user must have admin or owner permissions to the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/disable-deployment-protection-rule": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-secrets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -97592,75 +105938,77 @@ export interface operations { }; }; }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * - * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-public-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-or-update-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -97675,65 +106023,75 @@ export interface operations { responses: { /** @description Response when creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-secret": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Default response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List environment variables - * @description Lists all environment variables. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/list-environment-variables": { parameters: { query?: { + /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["variables-per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -97744,21 +106102,19 @@ export interface operations { }; }; }; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/create-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -97773,78 +106129,86 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; }; }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/get-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/delete-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "actions/update-environment-variable": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The name of the variable. */ name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -97859,53 +106223,69 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository events - * @description **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. - */ "activity/list-repo-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List forks */ "repos/list-forks": { parameters: { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -97914,20 +106294,17 @@ export interface operations { 400: components["responses"]["bad_request"]; }; }; - /** - * Create a fork - * @description Create a fork for the authenticated user. - * - * **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - * - * **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. - */ "repos/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -97944,6 +106321,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -97954,13 +106334,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Create a blob */ "git/create-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -97981,6 +106365,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["short-blob"]; @@ -97992,28 +106377,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a blob - * @description The `content` in the response will always be Base64 encoded. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw blob data. - * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. - * - * **Note** This endpoint supports blobs up to 100 megabytes in size. - */ "git/get-blob": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; file_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["blob"]; }; @@ -98024,45 +106407,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a commit - * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98108,6 +106463,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-commit"]; @@ -98118,52 +106474,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a commit object - * @description Gets a Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). - * - * To get the contents of a commit, see "[Get a commit](/rest/commits/commits#get-a-commit)." - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-commit": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The SHA of the commit. */ commit_sha: components["parameters"]["commit-sha"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-commit"]; }; @@ -98172,29 +106503,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List matching references - * @description Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array. - * - * When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. - */ "git/list-matching-refs": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"][]; @@ -98203,23 +106535,30 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Get a reference - * @description Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. - * - * **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - */ "git/get-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -98228,16 +106567,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a reference - * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. - */ "git/create-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98255,6 +106595,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-ref"]; @@ -98264,38 +106605,52 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a reference - * @description Deletes the provided reference. - */ "git/delete-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a reference - * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - */ "git/update-ref": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ ref: components["parameters"]["git-ref-only"]; }; + cookie?: never; }; requestBody: { content: { @@ -98313,6 +106668,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-ref"]; }; @@ -98321,45 +106679,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a tag object - * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. - * - * **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/create-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98396,6 +106726,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tag"]; @@ -98405,48 +106736,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tag - * @description **Signature verification object** - * - * 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 | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on their account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "git/get-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; tag_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tag"]; }; @@ -98455,20 +106764,17 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * Create a tree - * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. - * - * If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "[Create a commit](https://docs.github.com/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/rest/git/refs#update-a-reference)." - * - * Returns an error if you try to delete a file that does not exist. - */ "git/create-tree": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98487,23 +106793,18 @@ export interface operations { * @enum {string} */ type?: "blob" | "tree" | "commit"; - /** - * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. + /** @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ sha?: string | null; - /** - * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. + /** @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * - * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. - */ + * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ content?: string; }[]; - /** - * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. - * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. - */ + /** @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. + * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. + * */ base_tree?: string; }; }; @@ -98514,6 +106815,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["git-tree"]; @@ -98525,31 +106827,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a tree - * @description Returns a single tree using the SHA1 value or ref name for that tree. - * - * If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. - * - * - * **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. - */ "git/get-tree": { parameters: { query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ recursive?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ tree_sha: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["git-tree"]; }; @@ -98559,26 +106860,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository webhooks - * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. - */ "repos/list-webhooks": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"][]; @@ -98587,17 +106892,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository webhook - * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can - * share the same `config` as long as those webhooks do not have any `events` that overlap. - */ "repos/create-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98614,8 +106919,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @@ -98632,6 +106937,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["hook"]; @@ -98642,21 +106948,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository webhook - * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." - */ "repos/get-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -98664,34 +106976,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a repository webhook */ "repos/delete-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository webhook - * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." - */ "repos/update-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -98700,8 +107023,8 @@ export interface operations { /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ - * "push" - * ] + * "push" + * ] */ events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ @@ -98719,6 +107042,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook"]; }; @@ -98727,42 +107053,46 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a webhook configuration for a repository - * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. - */ "repos/get-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * Update a webhook configuration for a repository - * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. - */ "repos/update-webhook-config-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -98777,32 +107107,42 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - /** - * List deliveries for a repository webhook - * @description Returns a list of webhook deliveries for a webhook configured in a repository. - */ "repos/list-webhook-deliveries": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; redelivery?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery-item"][]; }; @@ -98811,22 +107151,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a delivery for a repository webhook - * @description Returns a delivery for a webhook configured in a repository. - */ "repos/get-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hook-delivery"]; }; @@ -98835,117 +107181,99 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Redeliver a delivery for a repository webhook - * @description Redeliver a webhook delivery for a webhook configured in a repository. - */ "repos/redeliver-webhook-delivery": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; delivery_id: components["parameters"]["delivery-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Ping a repository webhook - * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. - */ "repos/ping-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Test the push repository webhook - * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. - * - * **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` - */ "repos/test-push-webhook": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ hook_id: components["parameters"]["hook-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Get an import status - * @deprecated - * @description View the progress of an import. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - * - * **Import status** - * - * This section includes details about the possible values of the `status` field of the Import Progress response. - * - * An import that does not have errors will progress through these steps: - * - * * `detecting` - the "detection" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL. - * * `importing` - the "raw" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import). - * * `mapping` - the "rewrite" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information. - * * `pushing` - the "push" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is "Writing objects". - * * `complete` - the import is complete, and the repository is ready on GitHub. - * - * If there are problems, you will see one of these in the `status` field: - * - * * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - * * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information. - * * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - * * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL. - * * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section. - * - * **The project_choices field** - * - * When multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type. - * - * **Git LFS related fields** - * - * This section includes details about Git LFS related fields that may be present in the Import Progress response. - * - * * `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken. - * * `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step. - * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. - * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. - */ "migrations/get-import-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["import"]; }; @@ -98954,21 +107282,17 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Start an import - * @deprecated - * @description Start a source import to a GitHub repository using GitHub Importer. - * Importing into a GitHub repository with GitHub Actions enabled is not supported and will - * return a status `422 Unprocessable Entity` response. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/start-import": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -98995,6 +107319,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/spraints/socm/import */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["import"]; @@ -99005,46 +107330,41 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Cancel an import - * @deprecated - * @description Stop an import for a repository. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/cancel-import": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Update an import - * @deprecated - * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API - * request. If no parameters are provided, the import will be restarted. - * - * Some servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will - * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. - * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/update-import": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99070,6 +107390,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["import"]; }; @@ -99077,28 +107400,28 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Get commit authors - * @deprecated - * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. - * - * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/get-commit-authors": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["porter-author"][]; }; @@ -99107,21 +107430,18 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Map a commit author - * @deprecated - * @description Update an author's identity for the import. Your application can continue updating authors any time before you push - * new commits to the repository. - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/map-commit-author": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; author_id: number; }; + cookie?: never; }; requestBody?: { content: { @@ -99136,6 +107456,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["porter-author"]; }; @@ -99145,23 +107468,25 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Get large files - * @deprecated - * @description List files larger than 100MB found during the import - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/get-large-files": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["porter-large-file"][]; }; @@ -99169,23 +107494,17 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Update Git LFS preference - * @deprecated - * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability - * is powered by [Git LFS](https://git-lfs.com). - * - * You can learn more about our LFS feature and working with large files [on our help - * site](https://docs.github.com/repositories/working-with-files/managing-large-files). - * - * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - */ "migrations/set-lfs-preference": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99201,6 +107520,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["import"]; }; @@ -99209,22 +107531,25 @@ export interface operations { 503: components["responses"]["porter_maintenance"]; }; }; - /** - * Get a repository installation for the authenticated app - * @description Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-repo-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; @@ -99233,20 +107558,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get interaction restrictions for a repository - * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. - */ "interactions/get-restrictions-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["interaction-limit-response"] @@ -99255,16 +107585,17 @@ export interface operations { }; }; }; - /** - * Set interaction restrictions for a repository - * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. - */ "interactions/set-restrictions-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99274,58 +107605,76 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["interaction-limit-response"]; }; }; /** @description Response */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove interaction restrictions for a repository - * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. - */ "interactions/remove-restrictions-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List repository invitations - * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. - */ "repos/list-invitations": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -99333,30 +107682,44 @@ export interface operations { }; }; }; - /** Delete a repository invitation */ "repos/delete-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Update a repository invitation */ "repos/update-invitation": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99372,28 +107735,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - /** - * List repository issues - * @description List issues in a repository. Only open issues will be listed. - * - * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-for-repo": { parameters: { query?: { @@ -99407,24 +107757,35 @@ export interface operations { creator?: string; /** @description A user that's mentioned in the issue. */ mentioned?: string; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -99435,26 +107796,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create an issue - * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -99465,19 +107817,17 @@ export interface operations { body?: string; /** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_ */ assignee?: string | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; }; @@ -99489,6 +107839,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"]; @@ -99502,39 +107853,36 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List issue comments for a repository - * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. - * - * By default, issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments-for-repo": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -99544,28 +107892,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue comment - * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -99573,43 +107920,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an issue comment - * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - */ "issues/delete-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update an issue comment - * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -99622,6 +107970,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-comment"]; }; @@ -99629,10 +107980,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reactions for an issue comment - * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). - */ "reactions/list-for-issue-comment": { parameters: { query?: { @@ -99646,20 +107993,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -99668,17 +108024,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for an issue comment - * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. - */ "reactions/create-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -99702,12 +108060,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -99715,48 +108079,57 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. - * - * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). - */ "reactions/delete-for-issue-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List issue events for a repository - * @description Lists events for a repository. - */ "issues/list-events-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event"][]; @@ -99765,21 +108138,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an issue event - * @description Gets a single event by the event id. - */ "issues/get-event": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; event_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue-event"]; }; @@ -99789,38 +108167,27 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was - * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If - * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API - * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read - * 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 - * 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/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -99831,30 +108198,25 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Update an issue - * @description Issue owners and users with push access can edit an issue. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** @description The title of the issue. */ - title?: string | number | null; + title?: (string | number) | null; /** @description The contents of the issue. */ body?: string | null; /** @description Username to assign to this issue. **This field is deprecated.** */ @@ -99870,19 +108232,17 @@ export interface operations { * @enum {string|null} */ state_reason?: "completed" | "not_planned" | "reopened" | null; - milestone?: string | number | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - labels?: OneOf< - [ - string, - { + labels?: ( + | string + | { id?: number; name?: string; description?: string | null; color?: string | null; - }, - ] - >[]; + } + )[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; }; @@ -99891,6 +108251,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; @@ -99903,17 +108266,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Add assignees to an issue - * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. - */ "issues/add-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -99926,23 +108291,28 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Remove assignees from an issue - * @description Removes one or more assignees from an issue. - */ "issues/remove-assignees": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -99955,73 +108325,78 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["issue"]; }; }; }; }; - /** - * Check if a user can be assigned to a issue - * @description 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. - */ "issues/check-user-can-be-assigned-to-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; assignee: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * List issue comments - * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * Issue comments are ordered by ascending ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/list-comments": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"][]; @@ -100031,29 +108406,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create an issue comment - * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. - * - * 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. - * For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "issues/create-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -100069,6 +108434,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-comment"]; @@ -100080,27 +108446,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List issue events - * @description Lists all events for an issue. - */ "issues/list-events": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue-event-for-issue"][]; @@ -100109,27 +108480,32 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * List labels for an issue - * @description Lists all labels for an issue. - */ "issues/list-labels-on-issue": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -100140,38 +108516,40 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Set labels for an issue - * @description Removes any previous labels and sets the new labels for an issue. - */ "issues/set-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -100182,38 +108560,40 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. - */ "issues/add-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; - }, - { + } + | { labels?: { name: string; }[]; - }, - ] - >; + }; }; }; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -100224,44 +108604,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove all labels from an issue - * @description Removes all labels from an issue. - */ "issues/remove-all-labels": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 301: components["responses"]["moved_permanently"]; 404: components["responses"]["not_found"]; 410: components["responses"]["gone"]; }; }; - /** - * Remove a label from an issue - * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. - */ "issues/remove-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"][]; }; @@ -100271,29 +108663,29 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Lock an issue - * @description Users with push access can lock an issue or pull request's conversation. - * - * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "issues/lock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody?: { content: { "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` * @enum {string} */ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; @@ -100303,7 +108695,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; @@ -100311,31 +108706,33 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unlock an issue - * @description Users with push access can unlock an issue's conversation. - */ "issues/unlock": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List reactions for an issue - * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). - */ "reactions/list-for-issue": { parameters: { query?: { @@ -100349,20 +108746,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -100372,17 +108778,19 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** - * Create reaction for an issue - * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. - */ "reactions/create-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -100406,12 +108814,18 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -100419,49 +108833,59 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an issue reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. - * - * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). - */ "reactions/delete-for-issue": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List timeline events for an issue - * @description List all timeline events for an issue. - */ "issues/list-events-for-timeline": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["timeline-issue-events"][]; @@ -100471,23 +108895,30 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - /** List deploy keys */ "repos/list-deploy-keys": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"][]; @@ -100495,16 +108926,17 @@ export interface operations { }; }; }; - /** - * Create a deploy key - * @description You can create a read-only deploy key. - */ "repos/create-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100513,11 +108945,9 @@ export interface operations { title?: string; /** @description The contents of the key. */ key: string; - /** - * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. + /** @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * - * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." - */ + * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ read_only?: boolean; }; }; @@ -100528,6 +108958,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["deploy-key"]; @@ -100536,18 +108967,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** Get a deploy key */ "repos/get-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["deploy-key"]; }; @@ -100555,45 +108995,55 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a deploy key - * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. - */ "repos/delete-deploy-key": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List labels for a repository - * @description Lists all labels for a repository. - */ "issues/list-labels-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -100602,16 +109052,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a label - * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). - */ "issues/create-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100631,6 +109082,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"]; @@ -100640,21 +109092,26 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a label - * @description Gets a label using the given name. - */ "issues/get-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; @@ -100662,36 +109119,42 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a label - * @description Deletes a label using the given label name. - */ "issues/delete-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a label - * @description Updates a label using the given label name. - */ "issues/update-label": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; name: string; }; + cookie?: never; }; requestBody?: { content: { @@ -100708,54 +109171,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["label"]; }; }; }; }; - /** - * List repository languages - * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. - */ "repos/list-languages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["language"]; }; }; }; }; - /** - * Get the license for a repository - * @description This method returns the contents of the repository's license file, if one is detected. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. - * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "licenses/get-for-repo": { parameters: { query?: { + /** @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`. */ ref?: components["parameters"]["git-ref"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["license-content"]; }; @@ -100763,16 +109234,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Sync a fork branch with the upstream repository - * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. - */ "repos/merge-upstream": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100785,27 +109257,40 @@ export interface operations { responses: { /** @description The branch has been successfully synced with the upstream repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description The branch could not be synced for some other reason */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** Merge a branch */ "repos/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100822,30 +109307,38 @@ export interface operations { responses: { /** @description Successful Response (The resulting merge commit) */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Conflict when there is a merge conflict */ 409: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 422: components["responses"]["validation_failed"]; }; }; - /** - * List milestones - * @description Lists milestones for a repository. - */ "issues/list-milestones": { parameters: { query?: { @@ -100855,19 +109348,27 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"][]; @@ -100876,16 +109377,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a milestone - * @description Creates a milestone. - */ "issues/create-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -100914,6 +109416,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["milestone"]; @@ -100923,21 +109426,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a milestone - * @description Gets a milestone using the given milestone number. - */ "issues/get-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; @@ -100945,34 +109454,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a milestone - * @description Deletes a milestone using the given milestone number. - */ "issues/delete-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** Update a milestone */ "issues/update-milestone": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -100998,33 +109518,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["milestone"]; }; }; }; }; - /** - * List labels for issues in a milestone - * @description Lists labels for issues in a milestone. - */ "issues/list-labels-for-milestone": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the milestone. */ milestone_number: components["parameters"]["milestone-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["label"][]; @@ -101032,30 +109560,38 @@ export interface operations { }; }; }; - /** - * List repository notifications for the authenticated user - * @description Lists all notifications for the current user in the specified repository. - */ "activity/list-repo-notifications-for-authenticated-user": { parameters: { query?: { + /** @description If `true`, show notifications marked as read. */ all?: components["parameters"]["all"]; + /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ participating?: components["parameters"]["participating"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["thread"][]; @@ -101063,16 +109599,17 @@ export interface operations { }; }; }; - /** - * Mark repository notifications as read - * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. - */ "activity/mark-repo-notifications-as-read": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -101088,6 +109625,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -101097,26 +109637,32 @@ export interface operations { }; /** @description Reset Content */ 205: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get a GitHub Pages site - * @description Gets information about a GitHub Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -101124,97 +109670,109 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update information about a GitHub Pages site - * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/update-information-about-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @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. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: - | ("gh-pages" | "master" | "master /docs") - | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - }; + "application/json": + | { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @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. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: + | ("gh-pages" | "master" | "master /docs") + | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + } + | unknown + | unknown + | unknown + | unknown + | unknown; }; }; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 400: components["responses"]["bad_request"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a GitHub Pages site - * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/create-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path?: "/" | "/docs"; - }; - } | null; + "application/json": + | ( + | { + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path?: "/" | "/docs"; + }; + } + | unknown + | unknown + ) + | null; }; }; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page"]; }; @@ -101223,53 +109781,56 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a GitHub Pages site - * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/delete-pages-site": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List GitHub Pages builds - * @description Lists builts of a GitHub Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/list-pages-builds": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["page-build"][]; @@ -101277,85 +109838,93 @@ export interface operations { }; }; }; - /** - * Request a GitHub Pages build - * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. - * - * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. - */ "repos/request-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - /** - * Get latest Pages build - * @description Gets information about the single most recent build of a GitHub Pages site. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-latest-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Get GitHub Pages build - * @description Gets information about a GitHub Pages build. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages-build": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; build_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-build"]; }; }; }; }; - /** - * Create a GitHub Pages deployment - * @description Create a GitHub Pages deployment for a repository. - * - * The authenticated user must have write permission to the repository. - */ "repos/create-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -101382,6 +109951,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["page-deployment"]; }; @@ -101391,23 +109963,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the status of a GitHub Pages deployment - * @description Gets the current status of a GitHub Pages deployment. - * - * The authenticated user must have read permission for the GitHub Pages site. - */ "repos/get-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pages-deployment-status"]; }; @@ -101415,80 +109991,94 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Cancel a GitHub Pages deployment - * @description Cancels a GitHub Pages deployment. - * - * The authenticated user must have write permissions for the GitHub Pages site. - */ "repos/cancel-pages-deployment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 404: components["responses"]["not_found"]; }; }; - /** - * Get a DNS health check for GitHub Pages - * @description Gets a health check of the DNS settings for the `CNAME` record configured for a repository's GitHub Pages. - * - * 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. - * - * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "repos/get-pages-health-check": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pages-health-check"]; }; }; /** @description Empty response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Custom domains are not available for GitHub Pages */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description There isn't a CNAME for this page */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Check if private vulnerability reporting is enabled for a repository - * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". - */ "repos/check-private-vulnerability-reporting": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Private vulnerability reporting status */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { /** @description Whether or not private vulnerability reporting is enabled for the repository. */ @@ -101499,60 +110089,68 @@ export interface operations { 422: components["responses"]["bad_request"]; }; }; - /** - * Enable private vulnerability reporting for a repository - * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." - */ "repos/enable-private-vulnerability-reporting": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 422: components["responses"]["bad_request"]; }; }; - /** - * Disable private vulnerability reporting for a repository - * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". - */ "repos/disable-private-vulnerability-reporting": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 422: components["responses"]["bad_request"]; }; }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/list-for-repo": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -101565,16 +110163,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-repo": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -101589,6 +110188,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -101600,21 +110202,25 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get all custom property values for a repository - * @description Gets all custom property values that are set for a repository. - * Users with read access to the repository can use this endpoint. - */ "repos/get-custom-properties-values": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["custom-property-value"][]; }; @@ -101623,19 +110229,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create or update custom property values for a repository - * @description Create new or update existing custom property values for a repository. - * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - * - * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. - */ "repos/create-or-update-custom-properties-values": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -101648,30 +110252,16 @@ export interface operations { responses: { /** @description No Content when custom property values are successfully created or updated */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List pull requests - * @description Lists pull requests in a specified repository. - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list": { parameters: { query?: { @@ -101685,19 +110275,27 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-simple"][]; @@ -101707,27 +110305,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -101765,6 +110353,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request"]; @@ -101774,38 +110363,35 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, - * review comments are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments-for-repo": { parameters: { query?: { sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -101813,28 +110399,27 @@ export interface operations { }; }; }; - /** - * Get a review comment for a pull request - * @description Provides details for a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; @@ -101842,44 +110427,45 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a review comment for a pull request - * @description Deletes a review comment. - */ "pulls/delete-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - /** - * Update a review comment for a pull request - * @description Edits the content of a specified review comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -101892,16 +110478,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - /** - * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/list-for-pull-request-review-comment": { parameters: { query?: { @@ -101915,20 +110500,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -101937,17 +110531,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a pull request review comment - * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. - */ "reactions/create-for-pull-request-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -101971,12 +110567,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -101984,65 +110586,54 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a pull request comment reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` - * - * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). - */ "reactions/delete-for-pull-request-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * Get a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists details of a pull request by providing its number. - * - * When you get, [create](https://docs.github.com/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". - * - * The value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit. - * - * The value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request: - * - * * If merged as a [merge commit](https://docs.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit. - * * If merged via a [squash](https://docs.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch. - * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. - * - * 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. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "pulls/get": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @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. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -102054,26 +110645,19 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a pull request - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * 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 supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102097,6 +110681,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request"]; }; @@ -102105,19 +110692,19 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a codespace from a pull request - * @description Creates a codespace owned by the authenticated user for the specified pull request. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/create-with-pr-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -102151,12 +110738,18 @@ export interface operations { responses: { /** @description Response when the codespace was successfully created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -102167,39 +110760,38 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List review comments on a pull request - * @description Lists all review comments for a specified pull request. By default, review comments - * are in ascending order by ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-review-comments": { parameters: { query?: { + /** @description The property to sort the results by. */ sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ direction?: "asc" | "desc"; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"][]; @@ -102207,31 +110799,19 @@ export interface operations { }; }; }; - /** - * Create a review comment for a pull request - * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." - * - * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. - * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -102280,6 +110860,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -102289,28 +110870,21 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a reply for a review comment - * @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. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" - * and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-reply-for-review-comment": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the comment. */ comment_id: components["parameters"]["comment-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -102326,6 +110900,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-comment"]; @@ -102334,36 +110909,32 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete - * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) - * endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["commit"][]; @@ -102371,37 +110942,32 @@ export interface operations { }; }; }; - /** - * List pull requests files - * @description Lists the files in a specified pull request. - * - * **Note:** Responses include a maximum of 3000 files. The paginated response - * returns 30 files per page by default. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-files": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["diff-entry"][]; @@ -102412,41 +110978,51 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Check if a pull request has been merged - * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. - */ "pulls/check-if-merged": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if pull request has been merged */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if pull request has not been merged */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Merge a pull request - * @description Merges a pull request into the base branch. - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - */ "pulls/merge": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102468,6 +111044,9 @@ export interface operations { responses: { /** @description if merge was successful */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-merge-result"]; }; @@ -102476,6 +111055,9 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ 405: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -102485,6 +111067,9 @@ export interface operations { }; /** @description Conflict if sha was provided and pull request head did not match */ 409: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -102495,23 +111080,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get all requested reviewers for a pull request - * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. - */ "pulls/list-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review-request"]; @@ -102519,17 +111108,19 @@ export interface operations { }; }; }; - /** - * Request reviewers for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. - */ "pulls/request-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102544,6 +111135,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -102551,21 +111145,26 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove requested reviewers from a pull request - * @description Removes review requests from a pull request for a given set of users and/or teams. - */ "pulls/remove-requested-reviewers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -102580,6 +111179,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-simple"]; }; @@ -102587,34 +111189,32 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List reviews for a pull request - * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-reviews": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The list of reviews returns in chronological order. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["pull-request-review"][]; @@ -102622,32 +111222,19 @@ export interface operations { }; }; }; - /** - * Create a review for a pull request - * @description Creates a review on a specified 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - * - * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. - * - * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/create-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102684,6 +111271,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -102692,29 +111282,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get a review for a pull request - * @description Retrieves a pull request review by its ID. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/get-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -102722,25 +111312,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a review for a pull request - * @description Updates the contents of a specified review summary comment. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/update-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -102753,6 +111339,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -102760,29 +111349,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Delete a pending review for a pull request - * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/delete-pending-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -102791,35 +111380,34 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List comments for a pull request review - * @description Lists comments for a specific pull request review. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/list-comments-for-review": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["review-comment"][]; @@ -102828,29 +111416,21 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Dismiss a review for a pull request - * @description Dismisses a specified review on a pull request. - * - * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - * you must be a repository administrator or be included in the list of people or teams - * who can dismiss pull request reviews. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/dismiss-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -102868,6 +111448,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -102876,25 +111459,21 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Submit a review for a pull request - * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ "pulls/submit-review": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; + /** @description The unique identifier of the review. */ review_id: components["parameters"]["review-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -102912,6 +111491,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["pull-request-review"]; }; @@ -102921,17 +111503,19 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Update a pull request branch - * @description Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch. - */ "pulls/update-branch": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The number that identifies the pull request. */ pull_number: components["parameters"]["pull-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -102944,6 +111528,9 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -102955,29 +111542,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README - * @description Gets the preferred README for a repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -102986,31 +111572,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository README for a directory - * @description Gets the README from a repository directory. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. - * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). - */ "repos/get-readme-in-directory": { parameters: { query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ ref?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ dir: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-file"]; }; @@ -103019,28 +111604,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List releases - * @description This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/rest/repos/repos#list-repository-tags). - * - * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. - */ "repos/list-releases": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"][]; @@ -103049,18 +111636,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a release - * @description 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - */ "repos/create-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -103105,6 +111691,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release"]; @@ -103112,6 +111699,9 @@ export interface operations { }; /** @description Not Found if the discussion category name is invalid */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -103119,21 +111709,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a release asset - * @description To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response. - */ "repos/get-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; @@ -103142,33 +111738,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Delete a release asset */ "repos/delete-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release asset - * @description Users with push access to the repository can edit a release asset. - */ "repos/update-release-asset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the asset. */ asset_id: components["parameters"]["asset-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -103185,22 +111792,26 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; }; }; - /** - * Generate release notes content for a release - * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. - */ "repos/generate-release-notes": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -103219,6 +111830,9 @@ export interface operations { responses: { /** @description Name and body of generated release notes */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-notes-content"]; }; @@ -103226,44 +111840,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the latest release - * @description View the latest published full release for the repository. - * - * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. - */ "repos/get-latest-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; }; }; - /** - * Get a release by tag name - * @description Get a published release with the specified tag. - */ "repos/get-release-by-tag": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description tag parameter */ tag: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; @@ -103271,65 +111893,78 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a release - * @description Gets a public release with the specified release ID. - * - * **Note:** This returns an `upload_url` key corresponding to the endpoint - * for uploading release assets. This key is a hypermedia resource. For more information, see - * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." - */ "repos/get-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ 401: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Delete a release - * @description Users with push access to the repository can delete a release. - */ "repos/delete-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a release - * @description Users with push access to the repository can edit a release. - */ "repos/update-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -103360,36 +111995,50 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release"]; }; }; /** @description Not Found if the discussion category name is invalid */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** List release assets */ "repos/list-release-assets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["release-asset"][]; @@ -103397,39 +112046,22 @@ export interface operations { }; }; }; - /** - * Upload a release asset - * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in - * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. - * - * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - * - * Most libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - * - * `application/zip` - * - * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, - * you'll still need to pass your authentication to be able to upload an asset. - * - * When an upstream failure occurs, you will receive a `502 Bad Gateway` status. This may leave an empty asset with a state of `starter`. It can be safely deleted. - * - * **Notes:** - * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List release assets](https://docs.github.com/rest/releases/assets#list-release-assets)" - * endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). - * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). - * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. - */ "repos/upload-release-asset": { parameters: { query: { name: string; label?: string; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -103439,39 +112071,50 @@ export interface operations { responses: { /** @description Response for successful upload */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List reactions for a release - * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). - */ "reactions/list-for-release": { parameters: { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -103480,17 +112123,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create reaction for a release - * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. - */ "reactions/create-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -103506,12 +112151,18 @@ export interface operations { responses: { /** @description Reaction exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; @@ -103519,76 +112170,91 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a release reaction - * @description **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. - * - * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). - */ "reactions/delete-for-release": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the release. */ release_id: components["parameters"]["release-id"]; + /** @description The unique identifier of the reaction. */ reaction_id: components["parameters"]["reaction-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get rules for a branch - * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply - * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level - * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" - * enforcement statuses are not returned. - */ "repos/get-branch-rules": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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). */ branch: components["parameters"]["branch"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-rule-detailed"][]; }; }; }; }; - /** - * Get all repository rulesets - * @description Get all the rulesets for a repository. - */ "repos/get-repo-rulesets": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"][]; }; @@ -103597,16 +112263,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a repository ruleset - * @description Create a ruleset for a repository. - */ "repos/create-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; /** @description Request body */ requestBody: { @@ -103617,7 +112284,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103633,6 +112300,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -103641,29 +112311,40 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * List repository rule suites - * @description Lists suites of rule evaluations at the repository level. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." - */ "repos/get-repo-rule-suites": { parameters: { query?: { + /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ ref?: components["parameters"]["ref-in-query"]; + /** @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suites"]; }; @@ -103672,22 +112353,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get a repository rule suite - * @description Gets information about a suite of rule evaluations from within a repository. - * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." - */ "repos/get-repo-rule-suite": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. */ rule_suite_id: components["parameters"]["rule-suite-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["rule-suite"]; }; @@ -103696,26 +112385,30 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get a repository ruleset - * @description Get a ruleset for a repository. - */ "repos/get-repo-ruleset": { parameters: { query?: { /** @description Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -103724,18 +112417,19 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update a repository ruleset - * @description Update a ruleset for a repository. - */ "repos/update-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; /** @description Request body */ requestBody?: { @@ -103746,7 +112440,7 @@ export interface operations { /** * @description The target of the ruleset * - * **Note**: The `push` target is in beta and is subject to change. + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ target?: "branch" | "tag" | "push"; @@ -103762,6 +112456,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-ruleset"]; }; @@ -103770,88 +112467,110 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete a repository ruleset - * @description Delete a ruleset for a repository. - */ "repos/delete-repo-ruleset": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ ruleset_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - /** - * List secret scanning alerts for a repository - * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-alerts-for-repo": { parameters: { query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. By default all secret types are returned. + * See "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)" + * for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a secret scanning alert - * @description Gets a single secret scanning alert detected in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/get-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; @@ -103859,26 +112578,27 @@ export interface operations { 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * Update a secret scanning alert - * @description Updates the status of a secret scanning alert in an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/update-alert": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -103892,50 +112612,63 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ 400: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description State does not match the resolution or resolution comment */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List locations for a secret scanning alert - * @description Lists all locations for a given secret scanning alert for an eligible repository. - * - * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. - */ "secret-scanning/list-locations-for-alert": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @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. */ alert_number: components["parameters"]["alert-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["secret-scanning-location"][]; @@ -103943,40 +112676,46 @@ export interface operations { }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 503: components["responses"]["service_unavailable"]; }; }; - /** - * List repository security advisories - * @description Lists security advisories in a repository. - * - * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. - */ "security-advisories/list-repository-advisories": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ before?: components["parameters"]["pagination-before"]; + /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ after?: components["parameters"]["pagination-after"]; /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: number; /** @description Filter by state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"][]; }; @@ -103985,20 +112724,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a repository security advisory - * @description Creates a new repository security advisory. - * - * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/create-repository-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104008,6 +112744,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -104017,17 +112756,17 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Privately report a security vulnerability - * @description Report a security vulnerability to the maintainers of the repository. - * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. - */ "security-advisories/create-private-vulnerability-report": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104037,6 +112776,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -104046,28 +112788,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a repository security advisory - * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * - * Anyone can access any published security advisory on a public repository. - * - * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a - * collaborator on the security advisory. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. - */ "security-advisories/get-repository-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -104076,22 +112817,19 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update a repository security advisory - * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * - * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, - * or a collaborator on the repository security advisory. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/update-repository-advisory": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; requestBody: { content: { @@ -104101,6 +112839,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-advisory"]; }; @@ -104109,30 +112850,30 @@ export interface operations { 404: components["responses"]["not_found"]; /** @description Validation failed, or the endpoint has been spammed. */ 422: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["validation-error"]; }; }; }; }; - /** - * Request a CVE for a repository security advisory - * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." - * - * You may request a CVE for public repositories, but cannot do so for private repositories. - * - * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. - */ "security-advisories/create-repository-advisory-cve-request": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 400: components["responses"]["bad_request"]; @@ -104141,23 +112882,27 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a temporary private fork - * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. - * - * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. - */ "security-advisories/create-fork": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: components["parameters"]["ghsa_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["full-repository"]; }; @@ -104168,30 +112913,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List stargazers - * @description Lists the people that have starred the repository. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-stargazers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -104202,24 +112947,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the weekly commit activity - * @description - * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. - * - * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - * 10,000 or more commits, a 422 status code will be returned. - */ "repos/get-code-frequency-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -104228,24 +112974,32 @@ export interface operations { 204: components["responses"]["no_content"]; /** @description Repository contains more than 10,000 commits */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get the last year of commit activity - * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. - */ "repos/get-commit-activity-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-activity"][]; }; @@ -104254,28 +113008,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get all contributor commit activity - * @description - * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * - * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). - * * `a` - Number of additions - * * `d` - Number of deletions - * * `c` - Number of commits - * - * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. - */ "repos/get-contributors-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["contributor-activity"][]; }; @@ -104284,24 +113035,25 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Get the weekly commit count - * @description Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`. - * - * The array order is oldest week (index 0) to most recent week. - * - * The most recent week is seven days ago at UTC midnight to today at UTC midnight. - */ "repos/get-participation-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The array order is oldest week (index 0) to most recent week. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["participation-stats"]; }; @@ -104309,26 +113061,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the hourly commit count for each day - * @description Each array contains the day number, hour number, and number of commits: - * - * * `0-6`: Sunday - Saturday - * * `0-23`: Hour of day - * * Number of commits - * - * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. - */ "repos/get-punch-card-stats": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["code-frequency-stat"][]; }; @@ -104336,19 +113087,18 @@ export interface operations { 204: components["responses"]["no_content"]; }; }; - /** - * Create a commit status - * @description Users with push access in a repository can create commit statuses for a given SHA. - * - * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. - */ "repos/create-commit-status": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; sha: string; }; + cookie?: never; }; requestBody: { content: { @@ -104358,11 +113108,9 @@ export interface operations { * @enum {string} */ state: "error" | "failure" | "pending" | "success"; - /** - * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. - * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: - * `http://ci.example.com/user/repo/build/sha` - */ + /** @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` */ target_url?: string | null; /** @description A short description of the status. */ description?: string | null; @@ -104380,6 +113128,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["status"]; @@ -104387,26 +113136,30 @@ export interface operations { }; }; }; - /** - * List watchers - * @description Lists the people watching the specified repository. - */ "activity/list-watchers-for-repo": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -104414,20 +113167,25 @@ export interface operations { }; }; }; - /** - * Get a repository subscription - * @description Gets information about whether the authenticated user is subscribed to the repository. - */ "activity/get-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if you subscribe to the repository */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; @@ -104435,20 +113193,24 @@ export interface operations { 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set a repository subscription - * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. - */ "activity/set-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -104463,47 +113225,62 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - /** - * Delete a repository subscription - * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). - */ "activity/delete-repo-subscription": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** List repository tags */ "repos/list-tags": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["tag"][]; @@ -104511,22 +113288,25 @@ export interface operations { }; }; }; - /** - * List tag protection states for a repository - * @description This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ "repos/list-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"][]; }; @@ -104535,17 +113315,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a tag protection state for a repository - * @description This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/create-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104558,6 +113338,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["tag-protection"]; }; @@ -104566,78 +113349,83 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a tag protection state for a repository - * @description This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ "repos/delete-tag-protection": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + /** @description The unique identifier of the tag protection. */ tag_protection_id: components["parameters"]["tag-protection-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Download a repository archive (tar) - * @description 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 - * the `Location` header to make a second `GET` request. - * **Note**: For private repositories, these links are temporary and expire after five minutes. - */ "repos/download-tarball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * List repository teams - * @description Lists the teams that have access to the specified repository and that are also visible to the authenticated user. - * - * For a public repository, a team is listed only if that team added the public repository explicitly. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. - */ "repos/list-teams": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -104646,21 +113434,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Get all repository topics */ "repos/get-all-topics": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -104668,13 +113465,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Replace all repository topics */ "repos/replace-all-topics": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104687,6 +113488,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["topic"]; }; @@ -104695,23 +113499,28 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * Get repository clones - * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. - */ "repos/get-clones": { parameters: { query?: { + /** @description The time frame to display results for. */ per?: components["parameters"]["per"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["clone-traffic"]; }; @@ -104719,20 +113528,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get top referral paths - * @description Get the top 10 popular contents over the last 14 days. - */ "repos/get-top-paths": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["content-traffic"][]; }; @@ -104740,20 +113554,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get top referral sources - * @description Get the top 10 referrers over the last 14 days. - */ "repos/get-top-referrers": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["referrer-traffic"][]; }; @@ -104761,23 +113580,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get page views - * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. - */ "repos/get-views": { parameters: { query?: { + /** @description The time frame to display results for. */ per?: components["parameters"]["per"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["view-traffic"]; }; @@ -104785,16 +113609,17 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Transfer a repository - * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - */ "repos/transfer": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody: { content: { @@ -104811,113 +113636,128 @@ export interface operations { responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - /** - * Check if vulnerability alerts are enabled for a repository - * @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)". - */ "repos/check-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if repository is enabled with vulnerability alerts */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not enabled with vulnerability alerts */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Enable vulnerability alerts - * @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)". - */ "repos/enable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Disable vulnerability alerts - * @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)". - */ "repos/disable-vulnerability-alerts": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Download a repository archive (zip) - * @description 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 - * 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. - */ "repos/download-zipball-archive": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; ref: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ Location?: string; + [name: string]: unknown; }; - content: never; + content?: never; }; }; }; - /** - * Create a repository using a template - * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-using-template": { parameters: { + query?: never; + header?: never; path: { /** @description The account owner of the template repository. The name is not case sensitive. */ template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ template_repo: string; }; + cookie?: never; }; requestBody: { content: { @@ -104947,6 +113787,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -104954,26 +113795,24 @@ export interface operations { }; }; }; - /** - * List public repositories - * @description Lists all public repositories in the order that they were created. - * - * Note: - * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. - * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. - */ "repos/list-public": { parameters: { query?: { + /** @description A repository ID. Only return repositories with an ID greater than this ID. */ since?: components["parameters"]["since-repo"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -104983,29 +113822,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Search code - * @description Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - * - * For example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this: - * - * `q=addClass+in:file+language:js+repo:jquery/jquery` - * - * This query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository. - * - * Considerations for code search: - * - * Due to the complexity of searching code, there are a few restrictions on how searches are performed: - * - * * Only the _default branch_ is considered. In most cases, this will be the `master` branch. - * * Only files smaller than 384 KB are searchable. - * * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing - * language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - * - * This endpoint requires you to authenticate and limits you to 10 requests per minute. - */ "search/code": { parameters: { query: { @@ -105021,13 +113837,22 @@ export interface operations { * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -105042,17 +113867,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search commits - * @description Find commits via various criteria on the default branch (usually `main`). This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - * - * 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/search/search#text-match-metadata). - * - * For example, if you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this: - * - * `q=repo:octocat/Spoon-Knife+css` - */ "search/commits": { parameters: { query: { @@ -105060,14 +113874,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "author-date" | "committer-date"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -105079,21 +113903,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search issues and pull requests - * @description Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted - * search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - * - * For example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * `q=windows+label:bug+language:python+state:open&sort=created&order=asc` - * - * This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. - * - * **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." - */ "search/issues-and-pull-requests": { parameters: { query: { @@ -105112,14 +113921,24 @@ export interface operations { | "interactions" | "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -105134,18 +113953,6 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search labels - * @description Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - * - * For example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this: - * - * `q=bug+defect+enhancement&repository_id=64778136` - * - * The labels that best match the query appear first in the search results. - */ "search/labels": { parameters: { query: { @@ -105155,14 +113962,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "created" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -105177,18 +113994,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Search repositories - * @description Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - * - * For example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this: - * - * `q=tetris+language:assembly&sort=stars&order=desc` - * - * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. - */ "search/repos": { parameters: { query: { @@ -105196,14 +114001,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -105217,30 +114032,27 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Search topics - * @description Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/articles/searching-topics/)" for a detailed list of qualifiers. - * - * When searching for topics, you can get text match metadata for the topic's **short\_description**, **description**, **name**, or **display\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - * - * For example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this: - * - * `q=ruby+is:featured` - * - * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. - */ "search/topics": { parameters: { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ q: string; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -105252,20 +114064,6 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Search users - * @description Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api). - * - * When searching for users, you can get text match metadata for the issue **login**, public **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata). - * - * For example, if you're looking for a list of popular users, you might try this query: - * - * `q=tom+repos:%3E42+followers:%3E1000` - * - * This query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers. - * - * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." - */ "search/users": { parameters: { query: { @@ -105273,14 +114071,24 @@ export interface operations { q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ sort?: "followers" | "repositories" | "joined"; + /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -105294,20 +114102,23 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * Get a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. - */ "teams/get-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -105315,44 +114126,38 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - */ "teams/delete-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Update a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - */ "teams/update-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -105363,18 +114168,18 @@ export interface operations { description?: string; /** * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ privacy?: "secret" | "closed"; /** * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. * @enum {string} */ notification_setting?: @@ -105394,12 +114199,18 @@ export interface operations { responses: { /** @description Response when the updated information already exists */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-full"]; }; @@ -105409,31 +114220,30 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List discussions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussions-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion"][]; @@ -105441,22 +114251,15 @@ export interface operations { }; }; }; - /** - * Create a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; requestBody: { content: { @@ -105476,75 +114279,74 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody?: { content: { @@ -105559,38 +114361,41 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion"]; }; }; }; }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/list-discussion-comments-legacy": { parameters: { query?: { + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-discussion-comment"][]; @@ -105598,23 +114403,17 @@ export interface operations { }; }; }; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * 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. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/create-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -105627,78 +114426,80 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "teams/get-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/delete-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "teams/update-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -105711,21 +114512,15 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-discussion-comment"]; }; }; }; }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-comment-legacy": { parameters: { query?: { @@ -105739,20 +114534,29 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -105760,24 +114564,19 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-comment-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; + /** @description The number that identifies the comment. */ comment_number: components["parameters"]["comment-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -105801,21 +114600,15 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ "reactions/list-for-team-discussion-legacy": { parameters: { query?: { @@ -105829,19 +114622,27 @@ export interface operations { | "hooray" | "rocket" | "eyes"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["reaction"][]; @@ -105849,23 +114650,17 @@ export interface operations { }; }; }; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ "reactions/create-for-team-discussion-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The number that identifies the discussion. */ discussion_number: components["parameters"]["discussion-number"]; }; + cookie?: never; }; requestBody: { content: { @@ -105889,34 +114684,37 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["reaction"]; }; }; }; }; - /** - * List pending team invitations (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. - * - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - */ "teams/list-pending-invitations-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-invitation"][]; @@ -105924,30 +114722,30 @@ export interface operations { }; }; }; - /** - * List team members (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. - * - * Team members will include the members of child teams. - */ "teams/list-members-legacy": { parameters: { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -105956,126 +114754,123 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get team member (Legacy) - * @deprecated - * @description The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - */ "teams/get-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if user is a member */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if user is not a member */ 404: { - content: never; - }; - }; - }; - /** - * Add team member (Legacy) - * @deprecated - * @description The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams. - * - * 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 add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **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 that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/add-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ 422: { - content: never; - }; - }; - }; - /** - * Remove team member (Legacy) - * @deprecated - * @description The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships. - * - * 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 team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **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/)." - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/remove-member-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if team synchronization is setup */ 404: { - content: never; - }; - }; - }; - /** - * Get team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** - * The response contains the `state` of the membership and the member's `role`. - * - * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "teams/get-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; @@ -106083,27 +114878,17 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add or update team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. - * - * 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. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - * - * **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/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If 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. - */ "teams/add-or-update-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; requestBody?: { content: { @@ -106120,72 +114905,82 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Remove team membership for a user (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. - * - * 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/)." - */ "teams/remove-membership-for-user-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if team synchronization is set up */ 403: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List team projects (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ "teams/list-projects-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-project"][]; @@ -106194,46 +114989,49 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - */ "teams/check-permissions-for-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-project"]; }; }; /** @description Not Found if project is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - */ "teams/add-or-update-project-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; requestBody?: { content: { @@ -106249,10 +115047,16 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Forbidden if the project is not owned by the organization */ 403: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { message?: string; @@ -106264,49 +115068,53 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - */ "teams/remove-project-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The unique identifier of the project. */ project_id: components["parameters"]["project-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * List team repositories (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. - */ "teams/list-repos-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -106315,56 +115123,60 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check team permissions for a repository (Legacy) - * @deprecated - * @description **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: - */ "teams/check-permissions-for-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Alternative response with extra repository information */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description Not Found if repository is not managed by this team */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Add or update team repository permissions (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. - * - * 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 method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "teams/add-or-update-repo-permissions-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; requestBody?: { content: { @@ -106380,54 +115192,62 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 403: components["responses"]["forbidden"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove a repository from a team (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - */ "teams/remove-repo-legacy": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List child teams (Legacy) - * @deprecated - * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. - */ "teams/list-child-legacy": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the team. */ team_id: components["parameters"]["team-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team"][]; @@ -106438,14 +115258,20 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. - */ "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -106457,11 +115283,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Update the authenticated user - * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. - */ "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -106505,6 +115333,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["private-user"]; }; @@ -106516,20 +115347,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List users blocked by the authenticated user - * @description List the users you've blocked on your personal account. - */ "users/list-blocked-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["simple-user"][]; }; @@ -106540,46 +115376,57 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Check if a user is blocked by the authenticated user - * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. - */ "users/check-blocked": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description If the user is blocked */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description If the user is not blocked */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Block a user - * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. - */ "users/block": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -106588,20 +115435,24 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Unblock a user - * @description Unblocks the given user and returns a 204. - */ "users/unblock": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -106609,23 +115460,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List codespaces for the authenticated user - * @description Lists the authenticated user's codespaces. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description ID of the Repository to filter on */ repository_id?: components["parameters"]["repository-id-in-query"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -106640,20 +115495,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a codespace for the authenticated user - * @description Creates a new codespace, owned by the authenticated user. - * - * This endpoint requires either a `repository_id` OR a `pull_request` but not both. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { - "application/json": OneOf< - [ - { + "application/json": + | { /** @description Repository id for this codespace */ repository_id: number; /** @description Git ref (typically a branch name) for this codespace */ @@ -106681,8 +115533,8 @@ export interface operations { display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ retention_period_minutes?: number; - }, - { + } + | { /** @description Pull request number for this codespace */ pull_request: { /** @description Pull request number */ @@ -106705,20 +115557,24 @@ export interface operations { working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ idle_timeout_minutes?: number; - }, - ] - >; + }; }; }; responses: { /** @description Response when the codespace was successfully created */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -106729,27 +115585,25 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; - /** - * List secrets for the authenticated user - * @description Lists all development environment secrets available for a user's codespaces without revealing their - * encrypted values. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/list-secrets-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -106760,61 +115614,58 @@ export interface operations { }; }; }; - /** - * Get public key for the authenticated user - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/get-public-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-user-public-key"]; }; }; }; }; - /** - * Get a secret for the authenticated user - * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/get-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespaces-secret"]; }; }; }; }; - /** - * Create or update a secret for the authenticated user - * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using - * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/create-or-update-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -106831,56 +115682,62 @@ export interface operations { responses: { /** @description Response after successfully creating a secret */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response after successfully updating a secret */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete a secret for the authenticated user - * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/delete-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List selected repositories for a user secret - * @description List the repositories that have been granted the ability to use a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/list-repositories-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -106894,19 +115751,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Set selected repositories for a user secret - * @description Select the repositories that will use a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/set-repositories-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -106919,7 +115772,10 @@ export interface operations { responses: { /** @description No Content when repositories were added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -106927,25 +115783,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Add a selected repository to a user secret - * @description Adds a repository to the selected repositories for a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/add-repository-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was added to the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -106953,25 +115809,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Remove a selected repository from a user secret - * @description Removes a repository from the selected repositories for a user's development environment secret. - * - * The authenticated user must have Codespaces access to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. - */ "codespaces/remove-repository-for-secret-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the secret. */ secret_name: components["parameters"]["secret-name"]; repository_id: number; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description No Content when repository was removed from the selected list */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; @@ -106979,21 +115835,23 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get a codespace for the authenticated user - * @description Gets information about a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/get-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -107005,18 +115863,17 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Delete a codespace for the authenticated user - * @description Deletes a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/delete-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { 202: components["responses"]["accepted"]; 304: components["responses"]["not_modified"]; @@ -107026,19 +115883,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Update a codespace for the authenticated user - * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. - * - * If you specify a new machine type it will be applied the next time your codespace is started. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/update-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; requestBody?: { content: { @@ -107055,6 +115908,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -107064,23 +115920,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * 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. - * - * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/export-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 202: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace-export-details"]; }; @@ -107092,22 +115948,25 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get details about a codespace export - * @description Gets information about an export of a codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/get-export-details-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; + /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ export_id: components["parameters"]["export-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace-export-details"]; }; @@ -107115,21 +115974,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List machine types for a codespace - * @description List the machine types a codespace can transition to use. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/codespace-machines-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": { total_count: number; @@ -107144,21 +116005,15 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Create a repository from an unpublished codespace - * @description 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. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/publish-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; requestBody: { content: { @@ -107176,6 +116031,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace-with-full-repository"]; }; @@ -107186,21 +116044,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Start a codespace for the authenticated user - * @description Starts a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/start-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -107210,6 +116070,9 @@ export interface operations { 401: components["responses"]["requires_authentication"]; /** @description Payment required */ 402: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; @@ -107220,21 +116083,23 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Stop a codespace for the authenticated user - * @description Stops a user's codespace. - * - * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. - */ "codespaces/stop-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The name of the codespace. */ codespace_name: components["parameters"]["codespace-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["codespace"]; }; @@ -107245,27 +116110,33 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - /** - * Get list of conflicting packages during Docker migration for authenticated-user - * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; }; }; }; - /** - * Set primary email visibility for the authenticated user - * @description Sets the visibility for your primary email addresses. - */ "users/set-primary-email-visibility-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -107280,6 +116151,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["email"][]; }; @@ -107291,25 +116165,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible - * to the public. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -107321,11 +116195,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -107340,6 +116216,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["email"][]; }; @@ -107351,11 +116230,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete an email address for the authenticated user - * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody?: { content: { "application/json": { @@ -107367,7 +116248,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -107376,22 +116260,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List followers of the authenticated user - * @description Lists the people following the authenticated user. - */ "users/list-followers-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -107402,22 +116289,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List the people the authenticated user follows - * @description Lists the people who the authenticated user follows. - */ "users/list-followed-by-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -107428,45 +116318,57 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** Check if a person is followed by the authenticated user */ "users/check-person-is-followed-by-authenticated": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the person is followed by the authenticated user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * - * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/follow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -107474,20 +116376,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unfollow a user - * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. - */ "users/unfollow": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -107495,24 +116401,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -107524,13 +116431,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -107544,6 +116451,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -107555,21 +116465,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. - */ "users/get-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["gpg-key"]; }; @@ -107580,22 +116492,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. - */ "users/delete-gpg-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the GPG key. */ gpg_key_id: components["parameters"]["gpg-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -107604,26 +116518,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List app installations accessible to the user access token - * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * You can find the permissions for the installation under the `permissions` key. - */ "apps/list-installations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -107637,29 +116550,28 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List repositories accessible to the user access token - * @description List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - * - * The access the user has to each repository is included in the hash under the `permissions` key. - */ "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": { @@ -107674,60 +116586,79 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add a repository to an app installation - * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - */ "apps/add-repo-to-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Remove a repository from an app installation - * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - */ "apps/remove-repo-from-installation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the installation. */ installation_id: components["parameters"]["installation-id"]; + /** @description The unique identifier of the repository. */ repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */ 422: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Get interaction restrictions for your public repositories - * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires. - */ "interactions/get-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Default response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["interaction-limit-response"] @@ -107736,15 +116667,20 @@ export interface operations { }; /** @description Response when there are no restrictions */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * Set interaction restrictions for your public repositories - * @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. - */ "interactions/set-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": components["schemas"]["interaction-limit"]; @@ -107753,6 +116689,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["interaction-limit-response"]; }; @@ -107760,34 +116699,24 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Remove interaction restrictions from your public repositories - * @description Removes any interaction restrictions from your public repositories. - */ "interactions/remove-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; - }; - }; - }; - /** - * List user account issues assigned to the authenticated user - * @description 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 - * 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/pulls/pulls#list-pull-requests)" endpoint. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. - * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. - */ + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "issues/list-for-authenticated-user": { parameters: { query?: { @@ -107801,20 +116730,30 @@ export interface operations { | "all"; /** @description Indicates the state of the issues to return. */ state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["issue"][]; @@ -107824,24 +116763,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key"][]; @@ -107853,13 +116793,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. - */ "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -107876,6 +116816,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -107887,21 +116830,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. - */ "users/get-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["key"]; }; @@ -107912,22 +116857,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. - */ "users/delete-public-ssh-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the key. */ key_id: components["parameters"]["key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -107935,22 +116882,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List subscriptions for the authenticated user - * @description Lists the active subscriptions for the authenticated user. - */ "apps/list-subscriptions-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["user-marketplace-purchase"][]; @@ -107961,22 +116911,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List subscriptions for the authenticated user (stubbed) - * @description Lists the active subscriptions for the authenticated user. - */ "apps/list-subscriptions-for-authenticated-user-stubbed": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["user-marketplace-purchase"][]; @@ -107986,24 +116939,27 @@ export interface operations { 401: components["responses"]["requires_authentication"]; }; }; - /** - * List organization memberships for the authenticated user - * @description Lists all of the authenticated user's organization memberships. - */ "orgs/list-memberships-for-authenticated-user": { parameters: { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["org-membership"][]; @@ -108015,19 +116971,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an organization membership for the authenticated user - * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. - */ "orgs/get-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -108036,15 +116996,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Update an organization membership for the authenticated user - * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. - */ "orgs/update-membership-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; requestBody: { content: { @@ -108060,6 +117020,9 @@ export interface operations { responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["org-membership"]; }; @@ -108069,22 +117032,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List user migrations - * @description Lists all migrations a user has started. - */ "migrations/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["migration"][]; @@ -108095,11 +117061,13 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Start a user migration - * @description Initiates the generation of a user migration archive. - */ "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -108142,8 +117110,8 @@ export interface operations { /** * @description Exclude attributes from the API response to improve performance * @example [ - * "repositories" - * ] + * "repositories" + * ] */ exclude?: "repositories"[]; repositories: string[]; @@ -108153,6 +117121,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -108163,29 +117134,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user migration status - * @description Fetches a single user migration. The response includes the `state` of the migration, which can be one of the following values: - * - * * `pending` - the migration hasn't started yet. - * * `exporting` - the migration is in progress. - * * `exported` - the migration finished successfully. - * * `failed` - the migration failed. - * - * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). - */ "migrations/get-status-for-authenticated-user": { parameters: { query?: { exclude?: string[]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["migration"]; }; @@ -108196,60 +117163,48 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Download a user migration archive - * @description Fetches the URL to download the migration archive as a `tar.gz` file. Depending on the resources your repository uses, the migration archive can contain JSON files with data for these objects: - * - * * attachments - * * bases - * * commit\_comments - * * issue\_comments - * * issue\_events - * * issues - * * milestones - * * organizations - * * projects - * * protected\_branches - * * pull\_request\_reviews - * * pull\_requests - * * releases - * * repositories - * * review\_comments - * * schema - * * users - * - * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. - */ "migrations/get-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 302: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - /** - * Delete a user migration archive - * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. - */ "migrations/delete-archive-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -108257,21 +117212,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unlock a user repository - * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. - */ "migrations/unlock-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ repo_name: components["parameters"]["repo-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -108279,25 +117239,28 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories for a user migration - * @description Lists all the repositories for this user migration. - */ "migrations/list-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The unique identifier of the migration. */ migration_id: components["parameters"]["migration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -108306,24 +117269,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List organizations for the authenticated user - * @description List organizations for the authenticated user. - * - * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. - */ "orgs/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -108334,12 +117298,6 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List packages for the authenticated user's namespace - * @description Lists packages owned by the authenticated user within the user's namespace. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/list-packages-for-authenticated-user": { parameters: { query: { @@ -108351,14 +117309,27 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For 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)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -108366,104 +117337,112 @@ export interface operations { 400: components["responses"]["package_es_list_error"]; }; }; - /** - * Get a package for the authenticated user - * @description Gets a specific package for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for the authenticated user - * @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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list 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)." - */ "packages/delete-package-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for the authenticated user - * @description Restores a package owned by the authenticated user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/restore-package-for-authenticated-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by the authenticated user - * @description Lists package versions for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { query?: { + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ state?: "active" | "deleted"; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -108473,88 +117452,96 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for the authenticated user - * @description Gets a specific package version for a package owned by the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete a package version for the authenticated user - * @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. - * - * The authenticated user must have admin permissions in the organization to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/delete-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package version for the authenticated user - * @description Restores a package version owned by the authenticated user. - * - * You can restore a deleted package version under the following conditions: - * - 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. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/restore-package-version-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ "projects/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -108574,6 +117561,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["project"]; }; @@ -108584,26 +117574,25 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - /** - * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the - * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - * endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. - */ "users/list-public-emails-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["email"][]; @@ -108615,23 +117604,15 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories for the authenticated user - * @description Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - * - * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - */ "repos/list-for-authenticated-user": { parameters: { query?: { /** @description Limit results to repositories with the specified visibility. */ visibility?: "all" | "public" | "private"; - /** - * @description Comma-separated list of values. Can include: - * * `owner`: Repositories that are owned by the authenticated user. - * * `collaborator`: Repositories that the user has been added to as a collaborator. - * * `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: + * * `owner`: Repositories that are owned by the authenticated user. + * * `collaborator`: Repositories that the user has been added to as a collaborator. + * * `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. */ affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ type?: "all" | "owner" | "public" | "private" | "member"; @@ -108639,15 +117620,26 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; + /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before-repo-date"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["repository"][]; }; @@ -108658,13 +117650,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Create a repository for the authenticated user - * @description Creates a new repository for the authenticated user. - * - * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. - */ "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -108756,34 +117748,34 @@ export interface operations { /** * @description The default value for a squash merge commit title: * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @enum {string} */ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; @@ -108808,6 +117800,7 @@ export interface operations { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ Location?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["full-repository"]; @@ -108821,22 +117814,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List repository invitations for the authenticated user - * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. - */ "repos/list-invitations-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository-invitation"][]; @@ -108848,17 +117844,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** Decline a repository invitation */ "repos/decline-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -108866,17 +117869,24 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** Accept a repository invitation */ "repos/accept-invitation-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the invitation. */ invitation_id: components["parameters"]["invitation-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 403: components["responses"]["forbidden"]; @@ -108884,22 +117894,25 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; - /** - * List social accounts for the authenticated user - * @description Lists all of your social accounts. - */ "users/list-social-accounts-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -108911,13 +117924,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/add-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -108932,6 +117945,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["social-account"][]; }; @@ -108943,13 +117959,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "users/delete-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -108964,7 +117980,10 @@ export interface operations { responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -108973,24 +117992,25 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/list-ssh-signing-keys-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -109002,13 +118022,13 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. - */ "users/create-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; requestBody: { content: { "application/json": { @@ -109025,6 +118045,9 @@ export interface operations { responses: { /** @description Response */ 201: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -109036,21 +118059,23 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. - * - * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. - */ "users/get-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["ssh-signing-key"]; }; @@ -109061,22 +118086,24 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. - * - * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. - */ "users/delete-ssh-signing-key-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The unique identifier of the SSH signing key. */ ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -109084,28 +118111,29 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories starred by the authenticated user - * @description Lists repositories the authenticated user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-authenticated-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["repository"][]; @@ -109117,48 +118145,61 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Check if a repository is starred by the authenticated user - * @description Whether the authenticated user has starred the repository. - */ "activity/check-repo-is-starred-by-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response if this repository is starred by you */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; /** @description Not Found if this repository is not starred by you */ 404: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["basic-error"]; }; }; }; }; - /** - * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - */ "activity/star-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -109166,21 +118207,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Unstar a repository for the authenticated user - * @description Unstar a repository that the authenticated user has previously starred. - */ "activity/unstar-repo-for-authenticated-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; @@ -109188,22 +118234,25 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List repositories watched by the authenticated user - * @description Lists repositories the authenticated user is watching. - */ "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -109214,27 +118263,25 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated - * user belongs. - * - * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. - * - * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. - */ "teams/list-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["team-full"][]; @@ -109245,25 +118292,26 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * List users - * @description Lists all users, in the order that they signed up on GitHub. This list includes personal user accounts and organization accounts. - * - * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. - */ "users/list": { parameters: { query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { /** @example ; rel="next" */ Link?: string; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -109272,23 +118320,23 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - /** - * Get a user - * @description Provides publicly available information about someone with a GitHub account. - * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). - * - * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". - */ "users/get-by-username": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": | components["schemas"]["private-user"] @@ -109298,21 +118346,23 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get list of conflicting packages during Docker migration for user - * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. - */ "packages/list-docker-migration-conflicting-packages-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -109321,92 +118371,114 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * List events for the authenticated user - * @description If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. - */ "activity/list-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List organization events for the authenticated user - * @description This is the user's organization dashboard. You must be authenticated as the user to view this. - */ "activity/list-org-events-for-authenticated-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events for a user */ "activity/list-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List followers of a user - * @description Lists the people following the specified user. - */ "users/list-followers-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -109414,25 +118486,28 @@ export interface operations { }; }; }; - /** - * List the people a user follows - * @description Lists the people who the specified user follows. - */ "users/list-following-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["simple-user"][]; @@ -109440,45 +118515,59 @@ export interface operations { }; }; }; - /** Check if a user follows another user */ "users/check-following-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; target_user: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description if the user follows the target user */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; /** @description if the user does not follow the target user */ 404: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; }; }; - /** - * List gists for a user - * @description Lists public gists for the specified user: - */ "gists/list-for-user": { parameters: { query?: { + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["base-gist"][]; @@ -109487,25 +118576,28 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List GPG keys for a user - * @description Lists the GPG keys for a user. This information is accessible by anyone. - */ "users/list-gpg-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["gpg-key"][]; @@ -109513,14 +118605,6 @@ export interface operations { }; }; }; - /** - * Get contextual information for a user - * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - */ "users/get-context-for-user": { parameters: { query?: { @@ -109529,13 +118613,20 @@ export interface operations { /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ subject_id?: string; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["hovercard"]; }; @@ -109544,46 +118635,51 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * Get a user installation for the authenticated app - * @description Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - */ "apps/get-user-installation": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["installation"]; }; }; }; }; - /** - * List public keys for a user - * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. - */ "users/list-public-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["key-simple"][]; @@ -109591,27 +118687,28 @@ export interface operations { }; }; }; - /** - * List organizations for a user - * @description List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user. - * - * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. - */ "orgs/list-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["organization-simple"][]; @@ -109619,12 +118716,6 @@ export interface operations { }; }; }; - /** - * List packages for a user - * @description Lists all packages in a user's namespace for which the requesting user has access. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/list-packages-for-user": { parameters: { query: { @@ -109636,17 +118727,30 @@ export interface operations { | "docker" | "nuget" | "container"; + /** @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For 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)." */ visibility?: components["parameters"]["package-visibility"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"][]; }; @@ -109656,106 +118760,113 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; - /** - * Get a package for a user - * @description Gets a specific package metadata for a public package owned by a user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package"]; }; }; }; }; - /** - * Delete a package for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/delete-package-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore a package for a user - * @description Restores an entire package for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/restore-package-for-user": { parameters: { query?: { /** @description package token */ token?: string; }; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List package versions for a package owned by a user - * @description Lists package versions for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-all-package-versions-for-package-owned-by-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"][]; }; @@ -109765,109 +118876,119 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get a package version for a user - * @description Gets a specific package version for a public package owned by a specified user. - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/get-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["package-version"]; }; }; }; }; - /** - * Delete package version for a user - * @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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/delete-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * Restore package version for a user - * @description Restores a specific package version for a user. - * - * You can restore a deleted package under the following conditions: - * - 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. - * - * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. 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)." - * - * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. 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)." - */ "packages/restore-package-version-for-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ package_name: components["parameters"]["package-name"]; + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ package_version_id: components["parameters"]["package-version-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 204: { - content: never; + headers: { + [name: string]: unknown; + }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - /** - * List user projects - * @description Lists projects for a user. - */ "projects/list-for-user": { parameters: { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["project"][]; @@ -109876,53 +118997,62 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - /** - * List events received by the authenticated user - * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. - */ "activity/list-received-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** List public events received by a user */ "activity/list-received-public-events-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["event"][]; }; }; }; }; - /** - * List repositories for a user - * @description Lists public repositories for the specified user. - */ "repos/list-for-user": { parameters: { query?: { @@ -109932,18 +119062,25 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -109951,94 +119088,97 @@ export interface operations { }; }; }; - /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. - * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "billing/get-github-actions-billing-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["actions-billing-usage"]; }; }; }; }; - /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "billing/get-github-packages-billing-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["packages-billing-usage"]; }; }; }; }; - /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ "billing/get-shared-storage-billing-user": { parameters: { + query?: never; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["combined-billing-usage"]; }; }; }; }; - /** - * List social accounts for a user - * @description Lists social media accounts for a user. This endpoint is accessible by anyone. - */ "users/list-social-accounts-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["social-account"][]; @@ -110046,25 +119186,28 @@ export interface operations { }; }; }; - /** - * List SSH signing keys for a user - * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. - */ "users/list-ssh-signing-keys-for-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["ssh-signing-key"][]; @@ -110072,31 +119215,32 @@ export interface operations { }; }; }; - /** - * List repositories starred by a user - * @description Lists repositories a user has starred. - * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - * - * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. - */ "activity/list-repos-starred-by-user": { parameters: { query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": @@ -110106,25 +119250,28 @@ export interface operations { }; }; }; - /** - * List repositories watched by a user - * @description Lists repositories a user is watching. - */ "activity/list-repos-watched-by-user": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { "application/json": components["schemas"]["minimal-repository"][]; @@ -110132,14 +119279,20 @@ export interface operations { }; }; }; - /** - * Get all API versions - * @description Get all supported GitHub API versions. - */ "meta/get-all-versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string[]; }; @@ -110147,79 +119300,52 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - /** - * Get the Zen of GitHub - * @description Get a random sentence from the Zen of GitHub - */ "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": string; }; }; }; }; - /** - * Compare two commits - * @description **Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`. - * - * 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. - * - * 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, 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)." - * - * 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 following fields are included in the `verification` object: - * - * | Name | Type | Description | - * | ---- | ---- | ----------- | - * | `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. | - * | `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. | - * | `signature` | `string` | The signature that was extracted from the commit. | - * | `payload` | `string` | The value that was signed. | - * - * These are the possible values for `reason` in the `verification` object: - * - * | Value | Description | - * | ----- | ----------- | - * | `expired_key` | The key that made the signature is expired. | - * | `not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature. | - * | `gpgverify_error` | There was an error communicating with the signature verification service. | - * | `gpgverify_unavailable` | The signature verification service is currently unavailable. | - * | `unsigned` | The object does not include a signature. | - * | `unknown_signature_type` | A non-PGP signature was found in the commit. | - * | `no_user` | No user was associated with the `committer` email address in the commit. | - * | `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. | - * | `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. | - * | `unknown_key` | The key that made the signature has not been registered with any user's account. | - * | `malformed_signature` | There was an error parsing the signature. | - * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | - * | `valid` | None of the above errors applied, so the signature is considered to be verified. | - */ "repos/compare-commits": { parameters: { query?: { + /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ per_page?: components["parameters"]["per-page"]; + /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ page?: components["parameters"]["page"]; }; + header?: never; path: { + /** @description The account owner of the repository. The name is not case sensitive. */ owner: components["parameters"]["owner"]; + /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; base: string; head: string; }; + cookie?: never; }; + requestBody?: never; responses: { /** @description Response */ 200: { + headers: { + [name: string]: unknown; + }; content: { "application/json": components["schemas"]["commit-comparison"]; }; diff --git a/scripts/generate-types.js b/scripts/generate-types.js index 98d5c7164..f1f783095 100644 --- a/scripts/generate-types.js +++ b/scripts/generate-types.js @@ -2,7 +2,7 @@ import { readdir, mkdir, rm, writeFile, copyFile } from "node:fs/promises"; import { basename } from "node:path"; import * as prettier from "prettier"; -import openapiTS from "openapi-typescript"; +import openapiTS, { astToString, COMMENT_HEADER } from "openapi-typescript"; if (!process.env.OCTOKIT_OPENAPI_VERSION) { throw new Error("OCTOKIT_OPENAPI_VERSION is not set"); @@ -87,9 +87,15 @@ type Repository = components["schemas"]["full-repository"] await writeFile( `packages/${packageName}/types.d.ts`, - await prettier.format(await openapiTS(`cache/${name}.json`), { - parser: "typescript", - }), + await prettier.format( + COMMENT_HEADER + + astToString( + await openapiTS(new URL(`../cache/${name}.json`, import.meta.url)), + ), + { + parser: "typescript", + }, + ), ); console.log(`packages/${packageName}/types.d.ts written`); }